Skip to content

refactor: deprecate and clean up variable-related methods. #8415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gonfunko merged 2 commits into from
Jul 23, 2024
Merged

refactor: deprecate and clean up variable-related methods. #8415

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74fa283
refactor: deprecate and clean up variable-related methods.
gonfunko Jul 22, 2024
42bcfae
chore: Add deprecation JSDoc.
gonfunko Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core/field_variable.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ export class FieldVariable extends FieldDropdown {
if (variableTypes === null) {
// If variableTypes is null, return all variable types.
if (this.sourceBlock_ && !this.sourceBlock_.isDeadOrDying()) {
return this.sourceBlock_.workspace.getVariableTypes();
return this.sourceBlock_.workspace.getVariableMap().getTypes();
}
}
variableTypes = variableTypes || [''];
Expand Down
50 changes: 17 additions & 33 deletions core/variable_map.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,14 +84,9 @@ export class VariableMap
// The IDs may match if the rename is a simple case change (name1 ->
// Name1).
if (!conflictVar || conflictVar.getId() === variable.getId()) {
this.renameVariableAndUses_(variable, newName, blocks);
this.renameVariableAndUses(variable, newName, blocks);
} else {
this.renameVariableWithConflict_(
variable,
newName,
conflictVar,
blocks,
);
this.renameVariableWithConflict(variable, newName, conflictVar, blocks);
}
} finally {
eventUtils.setGroup(existingGroup);
Expand Down Expand Up @@ -124,6 +119,12 @@ export class VariableMap
* @param newName New variable name.
*/
renameVariableById(id: string, newName: string) {
deprecation.warn(
Comment thread
gonfunko marked this conversation as resolved.
'VariableMap.renameVariableById',
'v12',
'v13',
'VariableMap.renameVariable',
);
const variable = this.getVariableById(id);
if (!variable) {
throw Error("Tried to rename a variable that didn't exist. ID: " + id);
Expand All @@ -140,7 +141,7 @@ export class VariableMap
* @param newName New variable name.
* @param blocks The list of all blocks in the workspace.
*/
private renameVariableAndUses_(
private renameVariableAndUses(
variable: IVariableModel<IVariableState>,
newName: string,
blocks: Block[],
Expand All @@ -165,7 +166,7 @@ export class VariableMap
* @param conflictVar The variable that was already using newName.
* @param blocks The list of all blocks in the workspace.
*/
private renameVariableWithConflict_(
private renameVariableWithConflict(
variable: IVariableModel<IVariableState>,
newName: string,
conflictVar: IVariableModel<IVariableState>,
Expand All @@ -176,7 +177,7 @@ export class VariableMap

if (newName !== oldCase) {
// Simple rename to change the case and update references.
this.renameVariableAndUses_(conflictVar, newName, blocks);
this.renameVariableAndUses(conflictVar, newName, blocks);
}

// These blocks now refer to a different variable.
Expand Down Expand Up @@ -378,29 +379,6 @@ export class VariableMap
return [...this.variableMap.keys()];
}

/**
* Return all variable and potential variable types. This list always
* contains the empty string.
*
* @param ws The workspace used to look for potential variables. This can be
* different than the workspace stored on this object if the passed in ws
* is a flyout workspace.
* @returns List of variable types.
* @internal
*/
getVariableTypes(ws: Workspace | null): string[] {
const variableTypes = new Set<string>(this.variableMap.keys());
if (ws && ws.getPotentialVariableMap()) {
for (const key of ws.getPotentialVariableMap()!.getTypes()) {
variableTypes.add(key);
}
}
if (!variableTypes.has('')) {
variableTypes.add('');
}
return Array.from(variableTypes.values());
}

/**
* Return all variables of all types.
*
Expand All @@ -420,6 +398,12 @@ export class VariableMap
* @returns All of the variable names of all types.
*/
getAllVariableNames(): string[] {
deprecation.warn(
'VariableMap.getAllVariableNames',
'v12',
'v13',
'Blockly.Variables.getAllVariables',
);
const names: string[] = [];
Comment thread
gonfunko marked this conversation as resolved.
for (const variables of this.variableMap.values()) {
for (const variable of variables.values()) {
Expand Down
15 changes: 0 additions & 15 deletions core/variable_model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,21 +119,6 @@ export class VariableModel implements IVariableModel<IVariableState> {
// add the variable to that variable map, and fire a VAR_CREATE event.
workspace.createVariable(state['name'], state['type'], state['id']);
}

/**
* A custom compare function for the VariableModel objects.
*
* @param var1 First variable to compare.
* @param var2 Second variable to compare.
* @returns -1 if name of var1 is less than name of var2, 0 if equal, and 1 if
* greater.
* @internal
*/
static compareByName(var1: VariableModel, var2: VariableModel): number {
return var1
.getName()
.localeCompare(var2.getName(), undefined, {sensitivity: 'base'});
}
}

registry.register(
Expand Down
70 changes: 55 additions & 15 deletions core/workspace.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import type {IConnectionChecker} from './interfaces/i_connection_checker.js';
import {Options} from './options.js';
import * as registry from './registry.js';
import * as arrayUtils from './utils/array.js';
import * as deprecation from './utils/deprecation.js';
import * as idGenerator from './utils/idgenerator.js';
import * as math from './utils/math.js';
import type * as toolbox from './utils/toolbox.js';
Expand Down Expand Up @@ -388,6 +389,12 @@ export class Workspace implements IASTNodeLocation {
* @param newName New variable name.
*/
renameVariableById(id: string, newName: string) {
deprecation.warn(
'Blockly.Workspace.renameVariableById',
Comment thread
gonfunko marked this conversation as resolved.
'v12',
'v13',
'Blockly.Workspace.getVariableMap().renameVariable',
);
const variable = this.variableMap.getVariableById(id);
if (!variable) return;
this.variableMap.renameVariable(variable, newName);
Expand All @@ -409,6 +416,12 @@ export class Workspace implements IASTNodeLocation {
opt_type?: string | null,
opt_id?: string | null,
): IVariableModel<IVariableState> {
deprecation.warn(
'Blockly.Workspace.createVariable',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().createVariable',
);
return this.variableMap.createVariable(
name,
opt_type ?? undefined,
Expand All @@ -423,6 +436,12 @@ export class Workspace implements IASTNodeLocation {
* @returns Array of block usages.
*/
getVariableUsesById(id: string): Block[] {
deprecation.warn(
'Blockly.Workspace.getVariableUsesById',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getVariableUsesById',
);
return Variables.getVariableUsesById(this, id);
}

Expand All @@ -433,6 +452,12 @@ export class Workspace implements IASTNodeLocation {
* @param id ID of variable to delete.
*/
deleteVariableById(id: string) {
deprecation.warn(
'Blockly.Workspace.deleteVariableById',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().deleteVariable',
);
const variable = this.variableMap.getVariableById(id);
if (!variable) {
console.warn(`Can't delete non-existent variable: ${id}`);
Expand All @@ -454,6 +479,12 @@ export class Workspace implements IASTNodeLocation {
name: string,
opt_type?: string,
): IVariableModel<IVariableState> | null {
deprecation.warn(
'Blockly.Workspace.getVariable',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getVariable',
);
// TODO (#1559): Possibly delete this function after resolving #1559.
return this.variableMap.getVariable(name, opt_type);
}
Expand All @@ -465,6 +496,12 @@ export class Workspace implements IASTNodeLocation {
* @returns The variable with the given ID.
*/
getVariableById(id: string): IVariableModel<IVariableState> | null {
deprecation.warn(
'Blockly.Workspace.getVariableById',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getVariableById',
);
return this.variableMap.getVariableById(id);
}

Expand All @@ -477,22 +514,13 @@ export class Workspace implements IASTNodeLocation {
* if none are found.
*/
getVariablesOfType(type: string | null): IVariableModel<IVariableState>[] {
return this.variableMap.getVariablesOfType(type ?? '');
}

/**
* Return all variable types.
*
* @returns List of variable types.
* @internal
*/
getVariableTypes(): string[] {
const variableTypes = new Set<string>(this.variableMap.getTypes());
(this.potentialVariableMap?.getTypes() ?? []).forEach((t) =>
variableTypes.add(t),
deprecation.warn(
'Blockly.Workspace.getVariablesOfType',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getVariablesOfType',
);
variableTypes.add('');
return Array.from(variableTypes.values());
return this.variableMap.getVariablesOfType(type ?? '');
}

/**
Expand All @@ -501,6 +529,12 @@ export class Workspace implements IASTNodeLocation {
* @returns List of variable models.
*/
getAllVariables(): IVariableModel<IVariableState>[] {
deprecation.warn(
'Blockly.Workspace.getAllVariables',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getAllVariables',
);
return this.variableMap.getAllVariables();
}

Expand All @@ -510,6 +544,12 @@ export class Workspace implements IASTNodeLocation {
* @returns List of all variable names of all types.
*/
getAllVariableNames(): string[] {
deprecation.warn(
'Blockly.Workspace.getAllVariableNames',
'v12',
'v13',
'Blockly.Workspace.getVariableMap().getAllVariables',
);
return this.variableMap.getAllVariables().map((v) => v.getName());
}
/* End functions that are just pass-throughs to the variable map. */
Expand Down
3 changes: 1 addition & 2 deletions tests/mocha/field_variable_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,8 +388,7 @@ suite('Variable Fields', function () {
fieldVariable.variableTypes = null;

const resultTypes = fieldVariable.getVariableTypes();
// The empty string is always one of the options.
assert.deepEqual(resultTypes, ['type1', 'type2', '']);
assert.deepEqual(resultTypes, ['type1', 'type2']);
});
test('variableTypes is the empty list', function () {
const fieldVariable = new Blockly.FieldVariable('name1');
Expand Down
18 changes: 0 additions & 18 deletions tests/mocha/variable_map_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,24 +187,6 @@ suite('Variable Map', function () {
});
});

suite('getVariableTypes', function () {
test('Trivial', function () {
this.variableMap.createVariable('name1', 'type1', 'id1');
this.variableMap.createVariable('name2', 'type1', 'id2');
this.variableMap.createVariable('name3', 'type2', 'id3');
this.variableMap.createVariable('name4', 'type3', 'id4');
const resultArray = this.variableMap.getVariableTypes();
// The empty string is always an option.
assert.deepEqual(resultArray, ['type1', 'type2', 'type3', '']);
});

test('None', function () {
// The empty string is always an option.
const resultArray = this.variableMap.getVariableTypes();
assert.deepEqual(resultArray, ['']);
});
});

suite('getVariablesOfType', function () {
test('Trivial', function () {
const var1 = this.variableMap.createVariable('name1', 'type1', 'id1');
Expand Down