refactor: remove duplication code in ContextMenuManager (#8285) (CP: 23.7)

vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/pom.xml

@@ -85,6 +85,11 @@
             <artifactId>javax.servlet-api</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <plugins>

vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/ContextMenuManager.java

@@ -13,6 +13,8 @@
 import java.util.LinkedList;
 
 import org.apache.poi.ss.util.CellRangeAddress;
+import org.jsoup.Jsoup;
+import org.jsoup.safety.Safelist;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -42,6 +44,23 @@
 
     private int contextMenuHeaderIndex = -1;
 
+    /**
+     * Enum for spreadsheet action types.
+     */
+    enum ActionType {
+        CELL(0), ROW(1), COLUMN(2);
+
+        private final int value;
+
+        ActionType(int value) {
+            this.value = value;
+        }
+
+        public int getValue() {
+            return value;
+        }
+    }
+
     /**
      * Constructs a new ContextMenuManager and ties it to the given Spreadsheet.
      *
@@ -216,19 +235,11 @@
     protected ArrayList<SpreadsheetActionDetails> createActionsListForSelection() {
         ArrayList<SpreadsheetActionDetails> actions = new ArrayList<SpreadsheetActionDetails>();
         for (Handler handler : actionHandlers) {
-            Action[] actions2 = handler.getActions(spreadsheet
+            Action[] handlerActions = handler.getActions(spreadsheet
                     .getCellSelectionManager().getLatestSelectionEvent(),
                     spreadsheet);
-            if (actions2 != null) {
-                for (Action action : actions2) {
-                    String key = actionMapper.key(action);
-                    SpreadsheetActionDetails spreadsheetActionDetails = new SpreadsheetActionDetails();
-                    spreadsheetActionDetails.caption = action.getCaption();
-                    spreadsheetActionDetails.key = key;
-                    spreadsheetActionDetails.type = 0;
-                    actions.add(spreadsheetActionDetails);
-                }
-            }
+            actions.addAll(
+                    createActionDetailsList(handlerActions, ActionType.CELL));
         }
         return actions;
     }
@@ -246,14 +257,9 @@
         final CellRangeAddress column = new CellRangeAddress(-1, -1,
                 columnIndex - 1, columnIndex - 1);
         for (Handler handler : actionHandlers) {
-            for (Action action : handler.getActions(column, spreadsheet)) {
-                String key = actionMapper.key(action);
-                SpreadsheetActionDetails spreadsheetActionDetails = new SpreadsheetActionDetails();
-                spreadsheetActionDetails.caption = action.getCaption();
-                spreadsheetActionDetails.key = key;
-                spreadsheetActionDetails.type = 2;
-                actions.add(spreadsheetActionDetails);
-            }
+            Action[] handlerActions = handler.getActions(column, spreadsheet);
+            actions.addAll(
+                    createActionDetailsList(handlerActions, ActionType.COLUMN));
         }
         return actions;
     }
@@ -271,16 +277,40 @@
         final CellRangeAddress row = new CellRangeAddress(rowIndex - 1,
                 rowIndex - 1, -1, -1);
         for (Handler handler : actionHandlers) {
-            for (Action action : handler.getActions(row, spreadsheet)) {
+            Action[] handlerActions = handler.getActions(row, spreadsheet);
+            actions.addAll(
+                    createActionDetailsList(handlerActions, ActionType.ROW));
+        }
+        return actions;
+    }
+
+    /**
+     * Helper method to create SpreadsheetActionDetails from actions.
+     *
+     * @param actions
+     *            Array of actions to convert
+     * @param actionType
+     *            Type of the action (cell, row, or column)
+     * @return List of SpreadsheetActionDetails
+     */
+    private ArrayList<SpreadsheetActionDetails> createActionDetailsList(
+            Action[] actions, ActionType actionType) {
+        ArrayList<SpreadsheetActionDetails> actionDetailsList = new ArrayList<SpreadsheetActionDetails>();
+        if (actions != null) {
+            for (Action action : actions) {
                 String key = actionMapper.key(action);
                 SpreadsheetActionDetails spreadsheetActionDetails = new SpreadsheetActionDetails();
-                spreadsheetActionDetails.caption = action.getCaption();
+                String caption = action.getCaption();
+                if (caption == null) {
+                    caption = "";
+                }
+                spreadsheetActionDetails.caption = Jsoup.clean(caption,
+                        Safelist.relaxed());
                 spreadsheetActionDetails.key = key;
-                spreadsheetActionDetails.type = 1;
-                actions.add(spreadsheetActionDetails);
+                spreadsheetActionDetails.type = actionType.getValue();
+                actionDetailsList.add(spreadsheetActionDetails);
             }
         }
-        return actions;
+        return actionDetailsList;
     }
-
 }

vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/client/SpreadsheetActionDetails.java

@@ -14,6 +14,9 @@
 public class SpreadsheetActionDetails implements Serializable {
     public String caption;
     public String key;
-    /** 0 = cell, 1 = row, 2 = column TODO replace with enum type */
+    /**
+     * 0 = cell, 1 = row, 2 = column - kept as int for client-server
+     * compatibility
+     */
     public int type;
 }