[FIX] Range: Clean-up of plugins adaptRange

Following the refactoring that allows specific range transformations
inside commands, we always provide the sheetId and sheetName to the
range providers, which allows to clear some useless code.

Task: 4868971
X-original-commit: e031b43
Part-of: #7030
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>
Signed-off-by: Rémi Rahir (rar) <rar@odoo.com>

Author: rrahir

src/plugins/core/cell.ts

@@ -72,16 +72,12 @@ export class CellPlugin extends CorePlugin<CoreState> implements CoreState {
   readonly nextId = 1;
   public readonly cells: { [sheetId: string]: { [id: string]: Cell } } = {};
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, sheetName: string) {
     for (const sheet of Object.keys(this.cells)) {
       for (const cell of Object.values(this.cells[sheet] || {})) {
         if (cell.isFormula) {
           for (const range of cell.compiledFormula.dependencies) {
-            if (
-              !sheetId ||
-              range.sheetId === sheetId ||
-              (sheetName && range.invalidSheetName === sheetName)
-            ) {
+            if (range.sheetId === sheetId || range.invalidSheetName === sheetName) {
               const change = applyChange(range);
               if (change.changeType !== "NONE") {
                 this.history.update(

src/plugins/core/data_validation.ts

@@ -41,11 +41,8 @@ export class DataValidationPlugin
 
   readonly rules: { [sheet: string]: DataValidationRule[] } = {};
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
-    const sheetIds = sheetId ? [sheetId] : Object.keys(this.rules);
-    for (const sheetId of sheetIds) {
-      this.adaptDVRanges(sheetId, applyChange);
-    }
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID) {
+    this.adaptDVRanges(sheetId, applyChange);
     this.adaptDVFormulas(applyChange);
   }
 

src/plugins/core/figures.ts

@@ -32,10 +32,7 @@ export class FigurePlugin extends CorePlugin<FigureState> implements FigureState
   // Command Handling
   // ---------------------------------------------------------------------------
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID) {
-    if (!sheetId) {
-      return;
-    }
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID) {
     for (const figure of this.getFigures(sheetId)) {
       const change = applyChange(
         this.getters.getRangeFromZone(sheetId, {

src/plugins/core/merge.ts

@@ -123,11 +123,8 @@ export class MergePlugin extends CorePlugin<MergeState> implements MergeState {
     }
   }
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
-    const sheetIds = sheetId ? [sheetId] : Object.keys(this.merges);
-    for (const sheetId of sheetIds) {
-      this.applyRangeChangeOnSheet(sheetId, applyChange);
-    }
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID) {
+    this.applyRangeChangeOnSheet(sheetId, applyChange);
   }
 
   // ---------------------------------------------------------------------------

src/plugins/core/pivot.ts

@@ -139,7 +139,7 @@ export class PivotCorePlugin extends CorePlugin<CoreState> implements CoreState
     }
   }
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
+  adaptRanges(applyChange: ApplyRangeChange) {
     for (const sheetId in this.compiledMeasureFormulas) {
       for (const formulaString in this.compiledMeasureFormulas[sheetId]) {
         const compiledFormula = this.compiledMeasureFormulas[sheetId][formulaString];

src/plugins/core/range.ts

@@ -99,7 +99,7 @@ export class RangeAdapter implements CommandHandler<CoreCommand> {
     };
   }
 
-  private executeOnAllRanges(adaptRange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
+  private executeOnAllRanges(adaptRange: ApplyRangeChange, sheetId: UID, sheetName: string) {
     const func = this.verifyRangeRemoved(adaptRange);
     for (const provider of this.providers) {
       provider(func, sheetId, sheetName);

src/plugins/core/tables.ts

@@ -51,12 +51,9 @@ export class TablePlugin extends CorePlugin<TableState> implements TableState {
   readonly tables: Record<UID, Record<TableId, CoreTable | undefined>> = {};
   readonly nextTableId: number = 1;
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) {
-    const sheetIds = sheetId ? [sheetId] : this.getters.getSheetIds();
-    for (const sheetId of sheetIds) {
-      for (const table of this.getCoreTables(sheetId)) {
-        this.applyRangeChangeOnTable(sheetId, table, applyChange);
-      }
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID) {
+    for (const table of this.getCoreTables(sheetId)) {
+      this.applyRangeChangeOnTable(sheetId, table, applyChange);
     }
   }
 

src/plugins/core_plugin.ts

@@ -66,7 +66,7 @@ export class CorePlugin<State = any>
    * @param applyChange a function that, when called, will adapt the range according to the change on the grid
    * @param sheetId an optional sheetId to adapt either range of that sheet specifically, or ranges pointing to that sheet
    */
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string): void {}
+  adaptRanges(applyChange: ApplyRangeChange, sheetId: UID, sheetName: string): void {}
 
   /**
    * Implement this method to clean unused external resources, such as images

src/types/misc.ts

@@ -304,7 +304,7 @@ export type Dimension = "COL" | "ROW";
 export type ConsecutiveIndexes = HeaderIndex[];
 
 export interface RangeProvider {
-  adaptRanges: (applyChange: ApplyRangeChange, sheetId?: UID, sheetName?: string) => void;
+  adaptRanges: (applyChange: ApplyRangeChange, sheetId: UID, sheetName: string) => void;
 }
 
 export type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];

tests/range_plugin.test.ts

@@ -1,7 +1,7 @@
 import { CorePlugin, coreTypes, Model } from "../src";
 import { duplicateRangeInDuplicatedSheet } from "../src/helpers";
 import { corePluginRegistry } from "../src/plugins";
-import { ApplyRangeChange, Command, Range, UID } from "../src/types";
+import { ApplyRangeChange, Command, Range } from "../src/types";
 import { CellErrorType } from "../src/types/errors";
 import {
   addColumns,
@@ -39,7 +39,7 @@ class PluginTestRange extends CorePlugin {
 
   ranges: Range[] = [];
 
-  adaptRanges(applyChange: ApplyRangeChange, sheetId?: UID) {
+  adaptRanges(applyChange: ApplyRangeChange) {
     for (let i = 0; i < this.ranges.length; i++) {
       const range = this.ranges[i];
       const change = applyChange(range);