1105 add graphQL schema file creation action #1123
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <!-- | ||
| /** | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
| --> | ||
| <html lang="en"> | ||
| <body> | ||
| <font face="verdana" size="-1"> | ||
| <p> | ||
| The schema.graphqls file defines the basic structure of GraphQL queries and mutations. | ||
| </p> | ||
| <p> | ||
| Read more about <a href="https://devdocs.magento.com/guides/v2.4/graphql/develop/create-graphqls-file.html">Define the GraphQL schema for a module</a>. | ||
| </p> | ||
| </font> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| package com.magento.idea.magento2plugin.actions.context.xml; | ||
|
|
||
| import com.intellij.ide.fileTemplates.actions.AttributesDefaults; | ||
| import com.intellij.psi.PsiDirectory; | ||
| import com.intellij.psi.PsiFile; | ||
| import com.magento.idea.magento2plugin.actions.context.AbstractContextAction; | ||
| import com.magento.idea.magento2plugin.magento.files.GraphQLSchema; | ||
| import com.magento.idea.magento2plugin.magento.packages.ComponentType; | ||
| import com.magento.idea.magento2plugin.magento.packages.Package; | ||
| import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil; | ||
| import org.jetbrains.annotations.NotNull; | ||
|
|
||
|
|
||
| public class NewGraphQLSchemaAction extends AbstractContextAction { | ||
|
|
||
| public static final String ACTION_NAME = "Magento 2 GraphQL Schema File"; | ||
| public static final String ACTION_DESCRIPTION = "Create a new Magento 2 schema.graphqls file"; | ||
|
|
||
| /** | ||
| * New schema.graphqls file action constructor. | ||
| */ | ||
| public NewGraphQLSchemaAction() { | ||
| super(ACTION_NAME, ACTION_DESCRIPTION, GraphQLSchema.getInstance()); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean isVisible( | ||
| final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData, | ||
| final PsiDirectory targetDirectory, | ||
| final PsiFile targetFile | ||
| ) { | ||
| final PsiDirectory configDir = moduleData.getConfigDir(); | ||
|
|
||
| if (configDir == null) { | ||
| return false; | ||
| } | ||
|
|
||
| return targetDirectory.getName().equals(Package.moduleBaseAreaDir) | ||
| && targetDirectory.equals(configDir) | ||
| && moduleData.getType().equals(ComponentType.module); | ||
| } | ||
|
|
||
| @Override | ||
| protected AttributesDefaults getProperties( | ||
| final @NotNull AttributesDefaults defaults, | ||
| final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData, | ||
| final PsiDirectory targetDirectory, | ||
| final PsiFile targetFile | ||
| ) { | ||
| return defaults; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,49 @@ | ||||||||
| /* | ||||||||
| * Copyright © Magento, Inc. All rights reserved. | ||||||||
| * See COPYING.txt for license details. | ||||||||
| */ | ||||||||
|
|
||||||||
| package com.magento.idea.magento2plugin.actions.generation.generator; | ||||||||
|
|
||||||||
| import com.intellij.openapi.project.Project; | ||||||||
| import com.intellij.psi.PsiFile; | ||||||||
| import com.magento.idea.magento2plugin.actions.generation.generator.util.FindOrCreateGraphQLSchema; | ||||||||
| import java.util.Properties; | ||||||||
|
|
||||||||
| public class GraphQLSchemaGenerator extends FileGenerator { | ||||||||
|
|
||||||||
| private final String moduleName; | ||||||||
|
|
||||||||
|
There was a problem hiding this comment. Please, remove unnecessary empty line. |
||||||||
| private final FindOrCreateGraphQLSchema findOrCreateGraphQlSchema; | ||||||||
|
|
||||||||
|
|
||||||||
| /** | ||||||||
| * Constructor for graphQL schema file generator. | ||||||||
| * | ||||||||
| * @param moduleName String | ||||||||
| * @param project String | ||||||||
| */ | ||||||||
| public GraphQLSchemaGenerator( | ||||||||
| final String moduleName, | ||||||||
| final Project project) { | ||||||||
|
There was a problem hiding this comment. Please, reformat constructor:
Suggested change
|
||||||||
| super(project); | ||||||||
| this.moduleName = moduleName; | ||||||||
| findOrCreateGraphQlSchema = new FindOrCreateGraphQLSchema(project); | ||||||||
| } | ||||||||
|
|
||||||||
| @Override | ||||||||
| public PsiFile generate(final String actionName) { | ||||||||
| final PsiFile graphQLSchema = findOrCreateGraphQlSchema.execute( | ||||||||
| actionName, | ||||||||
| moduleName | ||||||||
| ); | ||||||||
|
|
||||||||
| if (graphQLSchema == null) { | ||||||||
| return null; | ||||||||
| } | ||||||||
| return graphQLSchema; | ||||||||
| } | ||||||||
|
|
||||||||
| @Override | ||||||||
| protected void fillAttributes(final Properties attributes) {} //NOPMD | ||||||||
| } | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /* | ||
| * Copyright © Magento, Inc. All rights reserved. | ||
| * See COPYING.txt for license details. | ||
| */ | ||
|
|
||
| package com.magento.idea.magento2plugin.actions.generation.generator.util; | ||
|
|
||
| import com.intellij.openapi.project.Project; | ||
| import com.intellij.psi.PsiDirectory; | ||
| import com.intellij.psi.PsiFile; | ||
| import com.magento.idea.magento2plugin.indexes.ModuleIndex; | ||
| import com.magento.idea.magento2plugin.magento.files.GraphQLSchema; | ||
| import com.magento.idea.magento2plugin.magento.files.ModuleFileInterface; | ||
| import com.magento.idea.magento2plugin.magento.packages.Areas; | ||
| import com.magento.idea.magento2plugin.magento.packages.Package; | ||
| import com.magento.idea.magento2plugin.util.magento.FileBasedIndexUtil; | ||
| import java.util.Properties; | ||
|
|
||
| public final class FindOrCreateGraphQLSchema { | ||
|
|
||
| private final Project project; | ||
|
|
||
| public FindOrCreateGraphQLSchema(final Project project) { | ||
| this.project = project; | ||
| } | ||
|
|
||
| /** | ||
| * Finds or creates graphQL schema file. | ||
| * | ||
| * @param actionName String | ||
| * @param moduleName String | ||
| * | ||
| * @return PsiFile | ||
| */ | ||
| public PsiFile execute(final String actionName, final String moduleName) { | ||
| PsiDirectory parentDirectory = new ModuleIndex(project) | ||
| .getModuleDirectoryByModuleName(moduleName); | ||
|
|
||
| if (parentDirectory == null) { | ||
| return null; | ||
| } | ||
| final DirectoryGenerator directoryGenerator = DirectoryGenerator.getInstance(); | ||
| final FileFromTemplateGenerator fileFromTemplateGenerator = | ||
| new FileFromTemplateGenerator(project); | ||
| parentDirectory = directoryGenerator | ||
| .findOrCreateSubdirectory(parentDirectory, Package.moduleBaseAreaDir); | ||
| final GraphQLSchema graphQlSchemaFile = GraphQLSchema.getInstance(); | ||
| PsiFile graphQlSchema = FileBasedIndexUtil.findModuleConfigFile( | ||
| graphQlSchemaFile.getFileName(), | ||
| Areas.getAreaByString(Areas.base.name()), | ||
| moduleName, | ||
| project | ||
| ); | ||
|
|
||
| if (graphQlSchema == null) { | ||
| graphQlSchema = fileFromTemplateGenerator.generate( | ||
| (ModuleFileInterface) graphQlSchema, | ||
| new Properties(), | ||
| parentDirectory, | ||
| actionName | ||
| ); | ||
| } | ||
| return graphQlSchema; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where did you use this generator?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bohdan-harniuk Hi! Thanks for your review. I fixed. Please, check. Thanks!