feat: Implement #9: Show Jeddict icon in NetBeans menus

This commit implements the user story from issue #9, allowing Jeddict icons to be displayed
before menu items in NetBeans, enhancing visibility and usability.

As part of this feature, significant refactoring was undertaken to improve code quality and maintainability:
- Introduced `BaseGitAction` to centralize Git project-related action logic.
- Introduced `BaseContextAction` for common context-aware action functionalities.
- Introduced `BaseProjectContextAction` for project-specific context actions.
- Refactored `GenerateCommitMessageAction` and `ReviewAction` to leverage these new base classes.
- Added comprehensive Javadoc to all classes within the `io.github.jeddict.ai.actions` package for improved code documentation.

Author: jGauravGupta

.gitignore

@@ -24,3 +24,4 @@ hs_err_pid*
 replay_pid*
 /target/
 test
+/src/var/

src/main/java/io/github/jeddict/ai/actions/AIAssistantPopupAction.java

@@ -18,8 +18,6 @@
 import io.github.jeddict.ai.hints.AssistantChatManager;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import javax.swing.AbstractAction;
-import static javax.swing.Action.NAME;
 import javax.swing.JOptionPane;
 import javax.swing.text.BadLocationException;
 import javax.swing.text.JTextComponent;
@@ -37,26 +35,42 @@
 import org.openide.util.Exceptions;
 import org.openide.util.NbBundle;
 
+/**
+ * A popup action that provides AI assistance in the editor. This action is
+ * available in the editor's context menu and can be invoked with a shortcut.
+ * It opens a chat window with the selected text and allows the user to interact
+ * with the AI assistant to modify the code.
+ */
 @ActionID(
-        category = "Edit/Chat",
-        id = "io.github.jeddict.ai.actions.AIAssistantPopupAction"
+    category = "Edit/Chat",
+    id = "io.github.jeddict.ai.actions.AIAssistantPopupAction"
 )
 @ActionRegistration(
-        displayName = "#CTL_AIAssistantPopupAction", lazy = false
+    displayName = "#CTL_AIAssistantPopupAction",
+    lazy = false,
+    iconInMenu = true,
+    iconBase = "icons/logo16.png"
 )
 @ActionReferences({
     @ActionReference(path = "Editors/Popup", position = 101),
     @ActionReference(path = "Shortcuts", name = "C-QUOTE")
 })
 @NbBundle.Messages("CTL_AIAssistantPopupAction=AI Assistant")
-public final class AIAssistantPopupAction extends AbstractAction implements ActionListener {
+public final class AIAssistantPopupAction extends BaseContextAction implements ActionListener {
 
+    /**
+     * Constructs a new AIAssistantPopupAction.
+     */
     public AIAssistantPopupAction() {
-        putValue(NAME, Bundle.CTL_AIAssistantPopupAction());
-        setEnabled(true);
+        super(Bundle.CTL_AIAssistantPopupAction(), true);
     }
 
-    
+    /**
+     * Opens the AI assistant chat window with the selected text from the
+     * editor.
+     *
+     * @param e the action event.
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
 
@@ -101,6 +115,15 @@ public void actionPerformed(ActionEvent e) {
         });
     }
 
+    /**
+     * Inserts the given content into the document and reformats the inserted
+     * text.
+     *
+     * @param document the document to modify.
+     * @param content the content to insert.
+     * @param startPosition the position at which to insert the content.
+     * @param lengthToRemove the length of the text to remove.
+     */
     private void insertAndReformat(StyledDocument document, String content, int startPosition, int lengthToRemove) {
         try {
             if (lengthToRemove > 0) {

src/main/java/io/github/jeddict/ai/actions/AddToChatContextAction.java

@@ -32,14 +32,21 @@
 import org.openide.windows.TopComponent;
 import org.openide.windows.WindowManager;
 
+/**
+ * An action that adds the selected file(s) or folder(s) to the current AI
+ * chat session context. This action is available in the context menu of files
+ * and folders in the Projects view.
+ */
 @ActionID(
-        category = "Project",
-        id = "io.github.jeddict.ai.actions.AddToChatContextAction"
+    category = "Project",
+    id = "io.github.jeddict.ai.actions.AddToChatContextAction"
 )
 @ActionRegistration(
-        displayName = "#CTL_AddToChatContextAction",
-        lazy = false,
-        asynchronous = false
+    displayName = "#CTL_AddToChatContextAction",
+    lazy = false,
+    iconInMenu = true,
+    iconBase = "icons/logo16.png",
+    asynchronous = false
 )
 @ActionReferences({
     @ActionReference(path = "Projects/package/Actions", position = 101),
@@ -49,23 +56,45 @@
 @Messages({"CTL_AddToChatContextAction=Add to Chat Session Context"})
 public final class AddToChatContextAction extends AbstractAction implements ContextAwareAction {
 
+    /**
+     * This method is never called directly. The action is handled by the
+     * context-aware instance.
+     *
+     * @param e the action event.
+     */
     @Override
     public void actionPerformed(ActionEvent e) {
-        // nikdy nebude volaná priamo - len cez ContextAction
+        // It will never be called directly—only through ContextAction
     }
 
+    /**
+     * Creates a context-aware instance of this action.
+     *
+     * @param context the lookup context.
+     * @return a new instance of the context-aware action.
+     */
     @Override
     public Action createContextAwareInstance(Lookup context) {
         List<FileObject> files = new ArrayList<>(context.lookupAll(FileObject.class));
         boolean en = !files.isEmpty() && isAssistantChatOpened();
         return new ContextAction(en, files);
     }
 
+    /**
+     * Returns true if the AI assistant chat is opened, false otherwise.
+     *
+     * @return true if the AI assistant chat is opened, false otherwise.
+     */
     @Override
     public boolean isEnabled() {
         return isAssistantChatOpened();
     }
 
+    /**
+     * Checks if the AI assistant chat window is opened and showing.
+     *
+     * @return true if the chat window is opened and showing, false otherwise.
+     */
     private static boolean isAssistantChatOpened() {
         Set<? extends Mode> modes = WindowManager.getDefault().getModes();
         for (Mode mode : modes) {
@@ -81,6 +110,11 @@ private static boolean isAssistantChatOpened() {
         return false;
     }
 
+    /**
+     * Returns the opened AI assistant chat window.
+     *
+     * @return the opened chat window, or null if it is not opened.
+     */
     private static TopComponent getOpenedAssistantChat() {
         Set<? extends Mode> modes = WindowManager.getDefault().getModes();
         for (Mode mode : modes) {
@@ -96,17 +130,30 @@ private static TopComponent getOpenedAssistantChat() {
         return null;
     }
 
-    private static final class ContextAction extends AbstractAction {
+    /**
+     * The context-aware action that adds the selected files to the chat
+     * session.
+     */
+    private static final class ContextAction extends BaseContextAction {
 
         private final List<FileObject> files;
 
+        /**
+         * Constructs a new ContextAction.
+         *
+         * @param enabled true to enable the action, false to disable it.
+         * @param files the list of files to add to the chat session.
+         */
         private ContextAction(boolean enabled, List<FileObject> files) {
-            super(Bundle.CTL_AddToChatContextAction());
+            super(Bundle.CTL_AddToChatContextAction(), enabled);
             this.files = files;
-            this.putValue(DynamicMenuContent.HIDE_WHEN_DISABLED, true);
-            setEnabled(enabled);
         }
 
+        /**
+         * Adds the selected files to the chat session context.
+         *
+         * @param e the action event.
+         */
         @Override
         public void actionPerformed(ActionEvent e) {
             TopComponent openedAssistantChat = getOpenedAssistantChat();
@@ -121,6 +168,11 @@ public void actionPerformed(ActionEvent e) {
             }
         }
 
+        /**
+         * Returns true if the AI assistant chat is opened, false otherwise.
+         *
+         * @return true if the AI assistant chat is opened, false otherwise.
+         */
         @Override
         public boolean isEnabled() {
             return isAssistantChatOpened();

src/main/java/io/github/jeddict/ai/actions/AskAIDBAction.java

@@ -27,16 +27,26 @@
 import org.openide.awt.ActionReference;
 import org.openide.awt.ActionReferences;
 import org.openide.awt.ActionRegistration;
-import org.openide.awt.DynamicMenuContent;
 import org.openide.util.ContextAwareAction;
 import org.openide.util.Lookup;
 import org.openide.util.NbBundle.Messages;
 
+/**
+ * An action that allows the user to ask AI questions about a database
+ * connection. This action is available in the context menu of a database
+ * connection in the Services window.
+ */
 @ActionID(
-        category = "File",
-        id = "io.github.jeddict.ai.actions.AskAIDBAction")
+    category = "File",
+    id = "io.github.jeddict.ai.actions.AskAIDBAction"
+)
 @ActionRegistration(
-        displayName = "#CTL_AskAIDBAction", lazy = false, asynchronous = true)
+    displayName = "#CTL_AskAIDBAction",
+    lazy = false,
+    asynchronous = true,
+    iconInMenu = true,
+    iconBase = "icons/logo16.png"
+)
 @ActionReferences({
  @ActionReference(path = "Databases/Explorer/Connection/Actions", position = 350),
 //    @ActionReference(path = "Databases/Explorer/Catalog/Actions", position = 350),
@@ -50,10 +60,22 @@
 @Messages({"CTL_AskAIDBAction=AI Assistant"})
 public final class AskAIDBAction extends AbstractAction implements ContextAwareAction {
 
+    /**
+     * This method is never called directly. The action is handled by the
+     * context-aware instance.
+     *
+     * @param ev the action event.
+     */
     @Override
     public void actionPerformed(ActionEvent ev) {
     }
 
+    /**
+     * Creates a context-aware instance of this action.
+     *
+     * @param actionContext the lookup context.
+     * @return a new instance of the context-aware action.
+     */
     @Override
     public Action createContextAwareInstance(Lookup actionContext) {
         if (actionContext != null) {
@@ -65,17 +87,30 @@ public Action createContextAwareInstance(Lookup actionContext) {
         return new AskAIDBAction.ContextAction(false, null);
     }
 
-    private static final class ContextAction extends AbstractAction {
+    /**
+     * The context-aware action that opens the AI chat window for the selected
+     * database connection.
+     */
+    private static final class ContextAction extends BaseContextAction {
 
         private final DatabaseConnection connection;
 
+        /**
+         * Constructs a new ContextAction.
+         *
+         * @param enable true to enable the action, false to disable it.
+         * @param connection the database connection.
+         */
         private ContextAction(boolean enable, DatabaseConnection connection) {
-            super(Bundle.CTL_AskAIDBAction());
-            this.putValue(DynamicMenuContent.HIDE_WHEN_DISABLED, true);
-            this.setEnabled(enable);
+            super(Bundle.CTL_AskAIDBAction(), enable);
             this.connection = connection;
         }
 
+        /**
+         * Opens the AI chat window for the selected database connection.
+         *
+         * @param evt the action event.
+         */
         @Override
         public void actionPerformed(ActionEvent evt) {
             if (connection == null) {

src/main/java/io/github/jeddict/ai/actions/AskAIPackageAction.java

@@ -30,31 +30,51 @@
 import org.openide.awt.ActionReference;
 import org.openide.awt.ActionReferences;
 import org.openide.awt.ActionRegistration;
-import org.openide.awt.DynamicMenuContent;
 import org.openide.filesystems.FileObject;
 import org.openide.util.ContextAwareAction;
 import org.openide.util.Lookup;
 import org.openide.util.NbBundle.Messages;
 
+/**
+ * An action that allows the user to ask AI questions about a package or a file.
+ * This action is available in the context menu of a package or a file in the
+ * Projects view.
+ */
 @ActionID(
-        category = "Project",
-        id = "io.github.jeddict.ai.actions.AskAIPackageAction")
+    category = "Project",
+    id = "io.github.jeddict.ai.actions.AskAIPackageAction"
+)
 @ActionRegistration(
-        displayName = "#CTL_AskAIPackageAction", lazy = true, asynchronous = true, iconBase = "icons/logo28.png")
+    displayName = "#CTL_AskAIPackageAction",
+        lazy = false,
+        asynchronous = true,
+        iconBase = "icons/logo16.png"
+)
 @ActionReferences({
     @ActionReference(path = "Projects/package/Actions", position = 100),
-    @ActionReference(path="Loaders/text/x-java/Actions", position=100),
+    @ActionReference(path = "Loaders/text/x-java/Actions", position=100),
     @ActionReference(path = "Loaders/folder/any/Actions", position = 300),
     @ActionReference(path = "Toolbars/Build", position = 100)})
 @Messages({"CTL_AskAIPackageAction=AI Assistant"})
 public final class AskAIPackageAction extends AbstractAction implements ContextAwareAction {
 
+    /**
+     * Opens the AI assistant chat window.
+     *
+     * @param ev the action event.
+     */
     @Override
     public void actionPerformed(ActionEvent ev) {
         AssistantChatManager learnFix = new AssistantChatManager(io.github.jeddict.ai.completion.Action.QUERY);
         learnFix.openChat(null, "", null, "AI Assistant", null);
     }
 
+    /**
+     * Creates a context-aware instance of this action.
+     *
+     * @param actionContext the lookup context.
+     * @return a new instance of the context-aware action.
+     */
     @Override
     public Action createContextAwareInstance(Lookup actionContext) {
         if (actionContext != null) {
@@ -70,17 +90,30 @@ public Action createContextAwareInstance(Lookup actionContext) {
         return new AskAIPackageAction.ContextAction(false, null);
     }
 
-    private static final class ContextAction extends AbstractAction {
+    /**
+     * The context-aware action that opens the AI chat window for the selected
+     * package or file.
+     */
+    private static final class ContextAction extends BaseContextAction {
 
         private final List<FileObject> selectedFileObjects;
 
+        /**
+         * Constructs a new ContextAction.
+         *
+         * @param enable true to enable the action, false to disable it.
+         * @param selectedPackages the list of selected packages or files.
+         */
         private ContextAction(boolean enable, List<FileObject> selectedPackages) {
-            super(Bundle.CTL_AskAIPackageAction());
-            this.putValue(DynamicMenuContent.HIDE_WHEN_DISABLED, true);
-            this.setEnabled(enable);
+            super(Bundle.CTL_AskAIPackageAction(), enable);
             this.selectedFileObjects = selectedPackages;
         }
 
+        /**
+         * Opens the AI chat window for the selected package or file.
+         *
+         * @param evt the action event.
+         */
         @Override
         public void actionPerformed(ActionEvent evt) {
             AssistantChatManager learnFix = new AssistantChatManager(io.github.jeddict.ai.completion.Action.QUERY, selectedFileObjects);