Add doc on how to develop the plugin and a little bit of cleanup

ArcBees · Jun 9, 2014 · f9a3a2f · f9a3a2f
1 parent f514bcb
commit f9a3a2f
Show file tree

Hide file tree

Showing 14 changed files with 45 additions and 55 deletions.
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/README.md b/README.md
@@ -25,6 +25,14 @@ Create the presenter and view classes quickly with this.
 ##Download
 * <a href="http://plugins.jetbrains.com/plugin/7318?pr=idea_ce" target="_blank">GWTP IDEA Plugin</a>
 
+##Develop the plugin (inspired by http://bjorn.tipling.com/how-to-make-an-intellij-idea-plugin-in-30-minutes)
+* Download and install the Community Edition of IntelliJ IDEA (it will be the SDK)
+* Download the source code of IntelliJ (to be able to debug)
+* Clone this repository and set the SDK of the project with the version you downloaded of IntelliJ
+* Add the source code of IntelliJ to your sourcepath
+* Add the maven.jar located in plugins/maven directory of the SDK to your classpath
+* Install the UI Designer (as prompted by your editor)
+
 ##Thanks to
 [![Arcbees.com](http://arcbees-ads.appspot.com/ad.png)](http://arcbees.com)
 

diff --git a/src/com/arcbees/plugin/idea/dialogs/ContentSlotDialog.java b/src/com/arcbees/plugin/idea/dialogs/ContentSlotDialog.java
@@ -31,7 +31,6 @@
 import javax.swing.*;
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
-import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Set;
@@ -118,7 +117,7 @@ public boolean process(PsiMember psiMember) {
     private String getSlot(PsiMember psiMember) {
         PsiClass container = psiMember.getContainingClass();
         String classname = container.getName();
-        String slot = classname + "." + psiMember.getName();
-        return slot;
+
+        return classname + "." + psiMember.getName();
     }
 }
diff --git a/src/com/arcbees/plugin/idea/domain/Archetype.java b/src/com/arcbees/plugin/idea/domain/Archetype.java
@@ -82,16 +82,16 @@ public String getCategoriesAsString() {
             return "";
         }
 
-        StringBuffer sb = new StringBuffer();
-        if (categories != null) {
-            for (int i = 0; i < categories.size(); i++) {
-                Category c = categories.get(i);
-                sb.append(c.getName());
-                if (i < categories.size() - 1) {
-                    sb.append(", ");
-                }
+        StringBuilder sb = new StringBuilder();
+
+        for (int i = 0; i < categories.size(); i++) {
+            Category c = categories.get(i);
+            sb.append(c.getName());
+            if (i < categories.size() - 1) {
+                sb.append(", ");
             }
         }
+
         return sb.toString();
     }
 
@@ -104,16 +104,16 @@ public String getTagsAsString() {
         if (tags == null) {
             return "";
         }
-        StringBuffer sb = new StringBuffer();
-        if (tags != null) {
-            for (int i = 0; i < tags.size(); i++) {
-                Tag t = tags.get(i);
-                sb.append(t.getName());
-                if (i < tags.size() - 1) {
-                    sb.append(", ");
-                }
+        StringBuilder sb = new StringBuilder();
+
+        for (int i = 0; i < tags.size(); i++) {
+            Tag t = tags.get(i);
+            sb.append(t.getName());
+            if (i < tags.size() - 1) {
+                sb.append(", ");
             }
         }
+
         return sb.toString();
     }
 

diff --git a/src/com/arcbees/plugin/idea/domain/ProjectConfigModel.java b/src/com/arcbees/plugin/idea/domain/ProjectConfigModel.java
@@ -65,12 +65,12 @@ public void setArchetypeSelected(Archetype archetypeSelected) {
 
     // TODO future
     public String getVersion() {
-        return "1.0-SNAPSHOT";
+        return "1.1.0";
     }
 
     // TODO future
     public String getDescription() {
-        return "This project was genereted by ArcBees Eclipse plugin.";
+        return "This project was generated by ArcBees IntelliJ IDEA plugin.";
     }
 
     @Override

diff --git a/src/com/arcbees/plugin/idea/moduletypes/CreateProjectModuleType.java b/src/com/arcbees/plugin/idea/moduletypes/CreateProjectModuleType.java
@@ -18,7 +18,6 @@
 
 import com.arcbees.plugin.idea.icons.PluginIcons;
 import com.intellij.openapi.module.ModuleType;
-import com.intellij.openapi.module.ModuleTypeManager;
 
 import javax.swing.*;
 

diff --git a/src/com/arcbees/plugin/idea/utils/PackageHierarchy.java b/src/com/arcbees/plugin/idea/utils/PackageHierarchy.java
@@ -50,7 +50,7 @@
 public class PackageHierarchy {
     private static final Logger logger = Logger.getLogger(PackageHierarchy.class.getName());
 
-    private PresenterConfigModel presenterConfigModel;
+    private final PresenterConfigModel presenterConfigModel;
     private Map<String, PackageHierarchyElement> packagesIndex;
 
     public PackageHierarchy(PresenterConfigModel presenterConfigModel) {
@@ -200,7 +200,7 @@ public void run() {
 
                         for (PsiClass unit : units) {
                             boolean found = findInterfaceUseInUnit(unit, findTypeName);
-                            if (found == true) {
+                            if (found) {
                                 psiClassModel.set(unit);
                             }
                         }
@@ -216,11 +216,9 @@ private boolean findInterfaceUseInUnit(PsiClass unit, String findTypeName) {
         for (PsiClassType types : unit.getSuperTypes()) {
             PsiType[] superTypes = types.getSuperTypes();
 
-            if (superTypes != null) {
-                for (PsiType superType : superTypes) {
-                    if (superType.getCanonicalText().contains(findTypeName)) {
-                        return true;
-                    }
+            for (PsiType superType : superTypes) {
+                if (superType.getCanonicalText().contains(findTypeName)) {
+                    return true;
                 }
             }
         }
@@ -247,8 +245,8 @@ private void indexPackage(VirtualFile root, PsiPackage packageFragment) {
         GlobalSearchScope scope = GlobalSearchScope.projectScope(presenterConfigModel.getProject());
         PsiPackage[] children = packageFragment.getSubPackages(scope);
 
-        for (int i = 0; i < children.length; i++) {
-            indexPackage(root, children[i]);
+        for (PsiPackage aChildren : children) {
+            indexPackage(root, aChildren);
         }
     }
 
@@ -269,9 +267,7 @@ public void run() {
             }
         }, ModalityState.NON_MODAL);
 
-        List<PsiClass> found = new ArrayList<PsiClass>(Arrays.asList(psiClassesModel.get()));
-
-        return found;
+        return new ArrayList<PsiClass>(Arrays.asList(psiClassesModel.get()));
     }
 
     private List<PackageRoot> getTopLevelPackages() {

diff --git a/src/com/arcbees/plugin/idea/utils/PackageHierarchyElement.java b/src/com/arcbees/plugin/idea/utils/PackageHierarchyElement.java
@@ -18,7 +18,6 @@
 
 import com.intellij.openapi.vfs.VirtualFile;
 import com.intellij.psi.PsiClass;
-import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiPackage;
 
 import java.util.HashMap;

diff --git a/src/com/arcbees/plugin/idea/utils/PackageRoot.java b/src/com/arcbees/plugin/idea/utils/PackageRoot.java
@@ -20,8 +20,8 @@
 import com.intellij.psi.PsiPackage;
 
 public class PackageRoot {
-    private VirtualFile root;
-    private PsiPackage psiPackage;
+    private final VirtualFile root;
+    private final PsiPackage psiPackage;
 
     public PackageRoot(VirtualFile root, PsiPackage psiPackage) {
         this.root = root;

diff --git a/src/com/arcbees/plugin/idea/utils/PackageUtilExt.java b/src/com/arcbees/plugin/idea/utils/PackageUtilExt.java
@@ -240,8 +240,7 @@ public static PsiDirectory findOrCreateDirectoryForPackage(@NotNull Module modul
             try {
                 foundExistingDirectory = ActionRunner.runInsideWriteAction(new ActionRunner.InterruptibleRunnableWithResult<PsiDirectory>() {
                     public PsiDirectory run() throws Exception {
-                        PsiDirectory foundExistingDirectory = passDir.findSubdirectory(name);
-                        return foundExistingDirectory;
+                        return passDir.findSubdirectory(name);
                     }
                 });
             } catch (Exception e) {

diff --git a/src/com/arcbees/plugin/idea/wizards/createpresenter/CreatePresenterAction.java b/src/com/arcbees/plugin/idea/wizards/createpresenter/CreatePresenterAction.java
@@ -307,12 +307,9 @@ public void run() {
 
     private PsiMethod findMethod(PsiClass unit, String methodName) {
         PsiMethod[] methods = unit.getMethods();
-        if (methods == null) {
-            return null;
-        }
 
         for (PsiMethod method : methods) {
-            if (method.getName().toString().contains(methodName)) {
+            if (method.getName().contains(methodName)) {
                 return method;
             }
         }
@@ -565,7 +562,6 @@ private void addMethodsToNameTokens(final PsiClass nameTokensPsiClass) {
         List<String> fields = createdNameTokenTemplates.getFields();
         List<String> methods = createdNameTokenTemplates.getMethods();
         final String fieldSource = fields.get(0).replaceAll("\n", "");
-        ;
         final String methodSource = methods.get(0);
 
         final PsiFieldModel psiFieldModel = new PsiFieldModel();
@@ -682,9 +678,8 @@ private void fetchTemplatesNameTokens() throws Exception {
         NameTokenOptions nameTokenOptions = new NameTokenOptions();
         nameTokenOptions.setPackageName(createdNameTokensPackage.getQualifiedName());
         nameTokenOptions.setNameTokens(nameTokens);
-        boolean processFileOnly = false;
 
-        createdNameTokenTemplates = CreateNameTokens.run(nameTokenOptions, true, processFileOnly);
+        createdNameTokenTemplates = CreateNameTokens.run(nameTokenOptions, true, false);
     }
 
     private void createPackageHierachyIndex() {
@@ -746,17 +741,15 @@ private void createNametokensClass() throws Exception {
     }
 
     private PsiClass createNewNameTokensClass() throws Exception {
-        boolean processFileOnly = true;
         NameTokenOptions nameTokenOptions = new NameTokenOptions();
         nameTokenOptions.setPackageName(createdNameTokensPackage.getQualifiedName());
         CreatedNameTokens createdNameToken;
 
-        createdNameToken = CreateNameTokens.run(nameTokenOptions, true, processFileOnly);
+        createdNameToken = CreateNameTokens.run(nameTokenOptions, true, true);
 
         RenderedTemplate renderedTemplate = createdNameToken.getNameTokensFile();
-        PsiClass createdPsiClass = createPsiClass(createdNameTokensPackage, renderedTemplate);
 
-        return createdPsiClass;
+        return createPsiClass(createdNameTokensPackage, renderedTemplate);
     }
 
     private PsiDirectory getBaseDir() {

diff --git a/src/com/arcbees/plugin/idea/wizards/createpresenter/CreatePresenterForm.java b/src/com/arcbees/plugin/idea/wizards/createpresenter/CreatePresenterForm.java
@@ -6,7 +6,6 @@
 import com.intellij.openapi.actionSystem.LangDataKeys;
 import com.intellij.openapi.module.Module;
 import com.intellij.openapi.module.ModuleUtil;
-import com.intellij.openapi.options.ConfigurationException;
 import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.DialogWrapper;
 import com.intellij.openapi.ui.ValidationInfo;

diff --git a/src/com/arcbees/plugin/idea/wizards/createproject/ArchetypesTableModel.java b/src/com/arcbees/plugin/idea/wizards/createproject/ArchetypesTableModel.java
@@ -21,7 +21,6 @@
 
 import javax.swing.table.DefaultTableModel;
 import java.util.List;
-import java.util.Vector;
 
 public class ArchetypesTableModel extends DefaultTableModel {
     private static final String[] COLUMN_TITLES = {"Name", "Categories", "Tags"};

diff --git a/src/com/arcbees/plugin/idea/wizards/createproject/FetchArchetypes.java b/src/com/arcbees/plugin/idea/wizards/createproject/FetchArchetypes.java
@@ -48,8 +48,7 @@ public class FetchArchetypes {
     public ArchetypeCollection fetchArchetypes() {
         initRestAssured();
 
-        ArchetypeCollection archetypeCollection = RestAssured.get(DIRECTORY_URL).as(ArchetypeCollection.class);
-        return archetypeCollection;
+        return RestAssured.get(DIRECTORY_URL).as(ArchetypeCollection.class);
     }
 
     private void initRestAssured() {