1016: Added test case and code refactoring

Author: bohdan-harniuk

src/com/magento/idea/magento2plugin/actions/generation/generator/ModuleReadmeMdGenerator.java

@@ -11,7 +11,7 @@
 import com.magento.idea.magento2plugin.actions.generation.data.ModuleReadmeMdData;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.DirectoryGenerator;
 import com.magento.idea.magento2plugin.actions.generation.generator.util.FileFromTemplateGenerator;
-import com.magento.idea.magento2plugin.magento.files.ModuleReadmeMd;
+import com.magento.idea.magento2plugin.magento.files.ModuleReadmeMdFile;
 import java.util.Properties;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -49,14 +49,10 @@ public ModuleReadmeMdGenerator(
     public PsiFile generate(final String actionName) {
         final PsiDirectory moduleDir = resolveModuleRoot(moduleReadmeMdData);
 
-        if (moduleDir == null) {
-            return null;
-        }
-
         return fileFromTemplateGenerator.generate(
-                ModuleReadmeMd.getInstance(),
+                new ModuleReadmeMdFile(),
                 getAttributes(),
-                moduleDir,
+                moduleDir != null ? moduleDir : moduleReadmeMdData.getBaseDir(),
                 actionName
         );
     }

src/com/magento/idea/magento2plugin/magento/files/ModuleReadmeMd.java renamed to src/com/magento/idea/magento2plugin/magento/files/ModuleReadmeMdFile.java

@@ -8,18 +8,10 @@
 import com.intellij.lang.Language;
 import com.intellij.lang.html.HTMLLanguage;
 
-public class ModuleReadmeMd implements ModuleFileInterface {
+public class ModuleReadmeMdFile implements ModuleFileInterface {
 
     public static final String FILE_NAME = "README.md";
     public static final String TEMPLATE = "Magento Module Readme File MD";
-    private static final ModuleReadmeMd INSTANCE = new ModuleReadmeMd();
-
-    /**
-     * Getter for singleton instance of class.
-     */
-    public static ModuleReadmeMd getInstance() {
-        return INSTANCE;
-    }
 
     @Override
     public String getFileName() {

testData/actions/generation/generator/ModuleReadmeMdGenerator/generateModuleReadmeMdFile/README.md

@@ -0,0 +1,10 @@
+# Foo_Bar module
+
+<!---
+    You can describe your module here.
+    We recommend that you add the following information:
+     - implementation details: why and how to use the module, preferably with some example scenarios
+     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
+     - extension points, APIs, plug-ins, etc
+     - any introduced events
+-->

tests/com/magento/idea/magento2plugin/actions/generation/generator/BaseGeneratorTestCase.java

@@ -53,6 +53,15 @@ protected void assertGeneratedFileIsCorrect(
         assertEquals(expectedFile.getName(), resultFile.getName());
     }
 
+    @SuppressWarnings({"PMD.JUnitAssertionsShouldIncludeMessage"})
+    protected void assertGeneratedFileIsCorrect(
+            final PsiFile expectedFile,
+            final PsiFile resultFile
+    ) {
+        assertEquals(expectedFile.getText(), resultFile.getText());
+        assertEquals(expectedFile.getName(), resultFile.getName());
+    }
+
     protected PsiDirectory getProjectDirectory() {
         return myFixture.getPsiManager().findDirectory(
                 GetProjectBasePath.execute(myFixture.getProject())

tests/com/magento/idea/magento2plugin/actions/generation/generator/ModuleReadmeMdGeneratorTest.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2plugin.actions.generation.generator;
+
+import com.intellij.psi.PsiFile;
+import com.magento.idea.magento2plugin.actions.generation.data.ModuleReadmeMdData;
+import com.magento.idea.magento2plugin.magento.files.ModuleReadmeMdFile;
+
+public final class ModuleReadmeMdGeneratorTest extends BaseGeneratorTestCase {
+
+    /**
+     * Test module README.md file generation.
+     */
+    public void testGenerateModuleReadmeMdFile() {
+        final PsiFile expectedFile = myFixture.configureByFile(
+                getFixturePath(ModuleReadmeMdFile.FILE_NAME)
+        );
+        final ModuleReadmeMdGenerator generator = new ModuleReadmeMdGenerator(
+                new ModuleReadmeMdData(
+                        "Foo",
+                        "Bar",
+                        getProjectDirectory()
+                ),
+                myFixture.getProject()
+        );
+        final PsiFile generatedFile = generator.generate("test");
+
+        assertGeneratedFileIsCorrect(
+                expectedFile,
+                generatedFile
+        );
+    }
+}