Merge remote-tracking branch 'origin/5.1.0-develop' into 1211-upgrade-intellij-plugin-to-1.5.2

# Conflicts:
#	src/com/magento/idea/magento2plugin/generation/php/MagentoTemplatesFactory.java

Author: VitaliyBoyko

CHANGELOG.md

@@ -4,8 +4,29 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).
 
+## 5.1.0
+
 ## 5.0.0
 
+### Added
+
+- Code generation of a Data Patch Boilerplate file [#1188](https://github.com/magento/magento2-phpstorm-plugin/pull/1188)
+- Code generation of an Observer from the context menu [#1200](https://github.com/magento/magento2-phpstorm-plugin/pull/1200)
+- Code generation of events.xml file [#1189](https://github.com/magento/magento2-phpstorm-plugin/pull/1189)
+- Config Scope directory inspection [#1261](https://github.com/magento/magento2-phpstorm-plugin/pull/1261)
+
+### Changed
+
+- EAV attributes code generators: Added default values of the group property [#1259](https://github.com/magento/magento2-phpstorm-plugin/pull/1259)
+- All code generators: Added constants visibility and class property types [#1260](https://github.com/magento/magento2-phpstorm-plugin/pull/1260)
+- UCT custom coming versions [#1251](https://github.com/magento/magento2-phpstorm-plugin/pull/1251)
+
+### Fixed
+
+- Fixed wrong director(y|ies) generation for GraphQL resolver class [#1192](https://github.com/magento/magento2-phpstorm-plugin/pull/1192)
+- Fixed IndexOutOfBoundsException: CreateResolverClassQuickFix.applyFix(CreateResolverClassQuickFix.java:43) [#1192](https://github.com/magento/magento2-phpstorm-plugin/pull/1192)
+- Index out of range [#1239](https://github.com/magento/magento2-phpstorm-plugin/pull/1239)
+
 ## 4.4.0
 
 ### Added

README.md

@@ -42,7 +42,7 @@
 
 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 `5.0.0-develop`)
+1. Make sure that you on the latest develop branch (e.g `5.1.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`

build.gradle

@@ -15,7 +15,7 @@ repositories {
 }
 
 group 'com.magento.idea'
-version '5.0.0'
+version '5.1.0'
 
 apply plugin: 'org.jetbrains.intellij'
 apply plugin: 'java'

resources/META-INF/plugin.xml

@@ -7,7 +7,7 @@
 <idea-plugin require-restart="true">
     <id>com.magento.idea.magento2plugin</id>
     <name>Magento PhpStorm</name>
-    <version>5.0.0</version>
+    <version>5.1.0</version>
     <vendor url="https://github.com/magento/magento2-phpstorm-plugin">Magento Inc.</vendor>
 
     <description><![CDATA[
@@ -315,6 +315,13 @@
                          enabledByDefault="true" level="WARNING"
                          implementationClass="com.magento.idea.magento2plugin.inspections.xml.PluginAttributeTypeInspection"/>
 
+        <localInspection language="XML" groupPath="XML"
+                         shortName="ModuleScopeInspection"
+                         bundle="magento2.inspection" key="inspection.displayName.ModuleScopeInspection"
+                         groupBundle="magento2.inspection" groupKey="inspection.group.name"
+                         enabledByDefault="true" level="WARNING"
+                         implementationClass="com.magento.idea.magento2plugin.inspections.xml.ModuleScopeInspection"/>
+
         <!-- UCT inspection -->
         <localInspection language="PHP" groupPath="UCT"
                          shortName="ExtendingDeprecatedClass"

resources/fileTemplates/internal/Magento Backend Controller Class.php.ft

@@ -15,7 +15,7 @@ class ${NAME}#if (${EXTENDS}) extends ${EXTENDS}#end#if (${IMPLEMENTS}) implemen
     /**
      * Authorization level of a basic admin session
      */
-    const ADMIN_RESOURCE = '${ACL}';
+    public const ADMIN_RESOURCE = '${ACL}';
 
 #end
     /**

resources/fileTemplates/internal/Magento Customer Eav Attribute Data Patch Class.php.ft

@@ -12,31 +12,31 @@ use $use;
 class ${CLASS_NAME} implements ${IMPLEMENTS}
 {
     /**
-     * @var ${MODULE_DATA_SETUP_INTERFACE}
-     */
-     private $moduleDataSetup;
+    * @var ${MODULE_DATA_SETUP_INTERFACE}
+    */
+    private ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup;
 
-     /**
-     * @var ${EAV_SETUP_FACTORY}
-     */
-    private $eavSetupFactory;
+    /**
+    * @var ${EAV_SETUP_FACTORY}
+    */
+    private ${EAV_SETUP_FACTORY} $eavSetupFactory;
 
     /**
-     * @var ${EAV_CONFIG_CLASS}
-     */
-    private $eavConfig;
+    * @var ${EAV_CONFIG_CLASS}
+    */
+    private ${EAV_CONFIG_CLASS} $eavConfig;
 
     /**
-     * @var ${ATTRIBUTE_RESOURCE}
-     */
-    private $attributeResource;
+    * @var ${ATTRIBUTE_RESOURCE}
+    */
+    private ${ATTRIBUTE_RESOURCE} $attributeResource;
 
-     /**
-     * @param ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup
-     * @param ${EAV_SETUP_FACTORY} $eavSetupFactory
-     * @param ${EAV_CONFIG_CLASS} $eavConfig
-     * @param ${ATTRIBUTE_RESOURCE} $attributeResource
-     */
+    /**
+    * @param ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup
+    * @param ${EAV_SETUP_FACTORY} $eavSetupFactory
+    * @param ${EAV_CONFIG_CLASS} $eavConfig
+    * @param ${ATTRIBUTE_RESOURCE} $attributeResource
+    */
     public function __construct(
         ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup,
         ${EAV_SETUP_FACTORY} $eavSetupFactory,

resources/fileTemplates/internal/Magento Data Model Interface.php.ft

@@ -16,7 +16,7 @@ interface ${NAME}
             #set ($propertyData = $property.split(";"))
             #set ($propertyUpperSnake = $propertyData.get(0))
             #set ($propertyLowerSnake = $propertyData.get(1))
-            const $propertyUpperSnake = "$propertyLowerSnake";
+            public const $propertyUpperSnake = "$propertyLowerSnake";
         #end
     #end
     #if (${PROPERTIES})

resources/fileTemplates/internal/Magento Data Model.php.ft

@@ -26,7 +26,7 @@ class ${NAME} #if (${EXTENDS})extends ${EXTENDS} #end #if (${IMPLEMENTS} && $has
             #set ($propertyData = $property.split(";"))
             #set ($propertyUpperSnake = $propertyData.get(0))
             #set ($propertyLowerSnake = $propertyData.get(1))
-                const $propertyUpperSnake = "$propertyLowerSnake";
+                public const $propertyUpperSnake = "$propertyLowerSnake";
             #end
 
     #end

resources/fileTemplates/internal/Magento Delete Entity By Id Command.php.ft

@@ -16,17 +16,17 @@ class ${CLASS_NAME}
     /**
      * @var ${LOGGER}
      */
-    private $logger;
+    private ${LOGGER} $logger;
 
     /**
      * @var ${MODEL_FACTORY}
      */
-    private $modelFactory;
+    private ${MODEL_FACTORY} $modelFactory;
 
     /**
      * @var ${RESOURCE}
      */
-    private $resource;
+    private ${RESOURCE} $resource;
 
     /**
      * @param ${LOGGER} $logger

resources/fileTemplates/internal/Magento Eav Attribute Data Patch Class.php.ft

@@ -15,12 +15,12 @@ class ${CLASS_NAME} implements ${IMPLEMENTS} {
      /**
      * @var ${MODULE_DATA_SETUP_INTERFACE}
      */
-     private $moduleDataSetup;
+     private ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup;
 
     /**
      * @var ${EAV_SETUP_FACTORY}
      */
-    private $eavSetupFactory;
+    private ${EAV_SETUP_FACTORY} $eavSetupFactory;
 
     /**
      * @param ${MODULE_DATA_SETUP_INTERFACE} $moduleDataSetup

resources/fileTemplates/internal/Magento Entity Data Mapper.php.ft

@@ -16,7 +16,7 @@ class ${CLASS_NAME}
     /**
      * @var ${DTO_FACTORY}
      */
-    private $entityDtoFactory;
+    private ${DTO_FACTORY} $entityDtoFactory;
 
     /**
      * @param ${DTO_FACTORY} $entityDtoFactory

resources/fileTemplates/internal/Magento Entity Delete Controller Class.php.ft

@@ -18,12 +18,12 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS_POST}, ${IMPLEMEN
      *
      * @see _isAllowed()
      */
-    const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
+    public const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
 
     /**
      * @var ${DELETE_COMMAND}
      */
-    private $deleteByIdCommand;
+    private ${DELETE_COMMAND} $deleteByIdCommand;
 
     /**
      * @param Context $context

resources/fileTemplates/internal/Magento Entity Edit Action Controller Class.php.ft

@@ -18,7 +18,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
      *
      * @see _isAllowed()
      */
-    const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
+    public const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
 
     /**
      * Edit ${ENTITY_NAME} action.

resources/fileTemplates/internal/Magento Entity Index Adminhtml Controller Class.php.ft

@@ -16,7 +16,7 @@ class ${CLASS_NAME} extends ${PARENT_CLASS_NAME} implements ${HTTP_GET_METHOD}
     /**
      * Authorization level of a basic admin session.
      */
-    const ADMIN_RESOURCE = '${ACL}';
+    public const ADMIN_RESOURCE = '${ACL}';
 
     /**
      * Execute action based on request and return result.

resources/fileTemplates/internal/Magento Entity New Action Controller Class.php.ft

@@ -18,7 +18,7 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
      *
      * @see _isAllowed()
      */
-    const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
+    public const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
 
     /**
      * Create new ${ENTITY_NAME} action.

resources/fileTemplates/internal/Magento Entity Save Controller Class.php.ft

@@ -18,22 +18,22 @@ class ${CLASS_NAME} extends ${EXTENDS} implements ${IMPLEMENTS}
      *
      * @see _isAllowed()
      */
-    const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
+    public const ADMIN_RESOURCE = '${ADMIN_RESOURCE}';
 
      /**
      * @var ${DATA_PERSISTOR}
      */
-    private $dataPersistor;
+    private ${DATA_PERSISTOR} $dataPersistor;
 
     /**
      * @var ${SAVE_COMMAND}
      */
-    private $saveCommand;
+    private ${SAVE_COMMAND} $saveCommand;
 
     /**
      * @var ${ENTITY_DTO_FACTORY}
      */
-    private $entityDataFactory;
+    private ${ENTITY_DTO_FACTORY} $entityDataFactory;
 
     /**
      * @param Context $context

resources/fileTemplates/internal/Magento Get List Query Model.php.ft

@@ -16,27 +16,27 @@ class ${CLASS_NAME}
     /**
      * @var ${COLLECTION_PROCESSOR_TYPE}
      */
-    private $collectionProcessor;
+    private ${COLLECTION_PROCESSOR_TYPE} $collectionProcessor;
 
     /**
      * @var ${ENTITY_COLLECTION_FACTORY_TYPE}
      */
-    private $entityCollectionFactory;
+    private ${ENTITY_COLLECTION_FACTORY_TYPE} $entityCollectionFactory;
 
     /**
      * @var ${ENTITY_DATA_MAPPER_TYPE}
      */
-    private $entityDataMapper;
+    private ${ENTITY_DATA_MAPPER_TYPE} $entityDataMapper;
 
     /**
      * @var ${SEARCH_CRITERIA_BUILDER_TYPE}
      */
-    private $searchCriteriaBuilder;
+    private ${SEARCH_CRITERIA_BUILDER_TYPE} $searchCriteriaBuilder;
 
     /**
      * @var ${SEARCH_RESULT_FACTORY_TYPE}
      */
-    private $searchResultFactory;
+    private ${SEARCH_RESULT_FACTORY_TYPE} $searchResultFactory;
 
     /**
      * @param ${COLLECTION_PROCESSOR_TYPE} $collectionProcessor

resources/fileTemplates/internal/Magento Grid Ui Component Action Column Class.php.ft

@@ -27,7 +27,7 @@ class ${CLASS_NAME} extends ${PARENT_CLASS}
     /**
      * @var ${URL}
      */
-    private $urlBuilder;
+    private ${URL} $urlBuilder;
 
     /**
      * @param ${CONTEXT} $context

resources/fileTemplates/internal/Magento Module Setup Patch File.php.ft

@@ -14,7 +14,7 @@ class ${CLASS_NAME} implements DataPatchInterface
     /**
      * @var ModuleDataSetupInterface
      */
-    private $moduleDataSetup;
+    private ModuleDataSetupInterface $moduleDataSetup;
 
     /**
      * @param ModuleDataSetupInterface $moduleDataSetup

resources/fileTemplates/internal/Magento PHP Form Generic Button Block Class.php.ft

@@ -16,12 +16,12 @@ class ${CLASS_NAME}
     /**
      * @var ${CONTEXT}
      */
-    private $context;
+    private ${CONTEXT} $context;
 
     /**
      * @var ${URL}
      */
-    private $urlBuilder;
+    private ${URL} $urlBuilder;
 
     /**
      * @param ${CONTEXT} $context

resources/fileTemplates/internal/Magento Save Entity Command Model.php.ft

@@ -16,17 +16,17 @@ class ${CLASS_NAME}
     /**
      * @var ${LOGGER}
      */
-    private $logger;
+    private ${LOGGER} $logger;
 
     /**
      * @var ${MODEL_FACTORY}
      */
-    private $modelFactory;
+    private ${MODEL_FACTORY} $modelFactory;
 
     /**
      * @var ${RESOURCE}
      */
-    private $resource;
+    private ${RESOURCE} $resource;
 
     /**
      * @param ${LOGGER} $logger

resources/fileTemplates/internal/Magento UI Component Custom Data Provider Class.php.ft

@@ -22,12 +22,12 @@ class ${CLASS_NAME} extends ${EXTENDS}
 /**
      * @var ${GET_LIST_QUERY_TYPE}
      */
-    private $getListQuery;
+    private ${GET_LIST_QUERY_TYPE} $getListQuery;
 
     /**
      * @var ${SEARCH_RESULT_FACTORY}
      */
-    private $searchResultFactory;
+    private ${SEARCH_RESULT_FACTORY} $searchResultFactory;
 
     /**
      * @var array