Add endpoint to reorder columns in spreadsheet configuration (#31)

Signed-off-by: Ayoub LABIDI <[email protected]>

Author: ayolab

src/main/java/org/gridsuite/studyconfig/server/controller/SpreadsheetConfigController.java

@@ -156,4 +156,14 @@ public ResponseEntity<Void> deleteColumn(
         return ResponseEntity.noContent().build();
     }
 
+    @PutMapping("/{id}/columns/reorder")
+    @Operation(summary = "Reorder columns", description = "Reorders the columns of a spreadsheet configuration")
+    @ApiResponse(responseCode = "204", description = "Columns reordered")
+    public ResponseEntity<Void> reorderColumns(
+                    @Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id,
+                    @Parameter(description = "New order of column IDs") @RequestBody List<UUID> columnOrder) {
+        spreadsheetConfigService.reorderColumns(id, columnOrder);
+        return ResponseEntity.noContent().build();
+    }
+
 }

src/main/java/org/gridsuite/studyconfig/server/service/SpreadsheetConfigService.java

@@ -253,6 +253,18 @@ public void deleteColumn(UUID id, UUID columnId) {
         spreadsheetConfigRepository.save(entity);
     }
 
+    @Transactional
+    public void reorderColumns(UUID id, List<UUID> columnOrder) {
+        SpreadsheetConfigEntity entity = findEntityById(id);
+        List<ColumnEntity> columns = entity.getColumns();
+
+        columns.sort((c1, c2) -> {
+            int idx1 = columnOrder.indexOf(c1.getUuid());
+            int idx2 = columnOrder.indexOf(c2.getUuid());
+            return Integer.compare(idx1, idx2);
+        });
+    }
+
     private SpreadsheetConfigCollectionInfos readDefaultSpreadsheetConfigCollection() throws IOException {
         try (InputStream inputStream = defaultSpreadsheetConfigCollectionResource.getInputStream()) {
             return objectMapper.readValue(inputStream, SpreadsheetConfigCollectionInfos.class);

src/test/java/org/gridsuite/studyconfig/server/SpreadsheetConfigIntegrationTest.java

@@ -28,6 +28,8 @@
 import java.util.Arrays;
 import java.util.List;
 import java.util.UUID;
+import java.util.Collections;
+import java.util.stream.Collectors;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
@@ -305,6 +307,39 @@ void testGetColumn() throws Exception {
         assertThat(column.uuid()).isEqualTo(columnId);
     }
 
+    @Test
+    void testReorderColumns() throws Exception {
+        SpreadsheetConfigInfos config = new SpreadsheetConfigInfos(null, "ReorderTest", SheetType.BATTERY, createColumns());
+        UUID configId = saveAndReturnId(config);
+
+        // get the saved config to retrieve column UUIDs
+        SpreadsheetConfigInfos savedConfig = getSpreadsheetConfig(configId);
+        List<ColumnInfos> originalColumns = savedConfig.columns();
+        assertThat(originalColumns).hasSize(4);
+
+        // reverse the original order
+        List<UUID> reorderedColumnIds = originalColumns.stream()
+            .map(ColumnInfos::uuid)
+            .collect(Collectors.toList());
+        Collections.reverse(reorderedColumnIds);
+
+        mockMvc.perform(put(URI_SPREADSHEET_CONFIG_GET_PUT + configId + URI_COLUMN_BASE + "/reorder")
+                .content(mapper.writeValueAsString(reorderedColumnIds))
+                .contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isNoContent());
+
+        // verify the new order
+        SpreadsheetConfigInfos updatedConfig = getSpreadsheetConfig(configId);
+        List<ColumnInfos> reorderedColumns = updatedConfig.columns();
+
+        assertThat(reorderedColumns).hasSize(originalColumns.size());
+
+        for (int i = 0; i < reorderedColumns.size(); i++) {
+            assertThat(reorderedColumns.get(i).uuid())
+                .isEqualTo(originalColumns.get(originalColumns.size() - 1 - i).uuid());
+        }
+    }
+
     private List<ColumnInfos> createColumns() {
         return Arrays.asList(
                 new ColumnInfos(null, "cust_a", ColumnType.BOOLEAN, null, "cust_b + cust_c", "[\"cust_b\", \"cust_c\"]", "idA"),