CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-02-15 03:50:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor!: Deprecate Block.getVars() (#9574)

Browse Source 
* refactor!: Deprecate `Block.getVars()`

* fix: Fix import path

* fix: Simplify test assertions
This commit is contained in:
Aaron Dodson
2026-01-20 11:19:50 -08:00
committed by GitHub
parent 2678f5845f
commit 4c79ea186f
10 changed files with 59 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
blocks/procedures.ts
View File

@@ -38,6 +38,7 @@ import type {
import {Msg} from '../core/msg.js';
import {Names} from '../core/names.js';
import * as Procedures from '../core/procedures.js';
import * as deprecation from '../core/utils/deprecation.js';
import * as xmlUtils from '../core/utils/xml.js';
import * as Variables from '../core/variables.js';
import type {Workspace} from '../core/workspace.js';
@@ -345,9 +346,17 @@ const PROCEDURE_DEF_COMMON = {
/**
* Return all variables referenced by this block.
*
* @deprecated v13: Use Blockly.libraryBlocks.procedures.getVarModels()
* .map(m => m.getName())
* @returns List of variable names.
*/
getVars: function (this: ProcedureBlock): string[] {
deprecation.warn(
'Blockly.libraryBlocks.procedures.getVars()',
'v13',
'v14',
'Blockly.libraryBlocks.procedures.getVarModels().map(model => model.getName())',
);
return this.arguments_;
},
/**
@@ -1020,9 +1029,17 @@ const PROCEDURE_CALL_COMMON = {
/**
* Return all variables referenced by this block.
*
* @deprecated v13: Use Blockly.libraryBlocks.procedures.getVarModels()
* .map(m => m.getName())
* @returns List of variable names.
*/
getVars: function (this: CallBlock): string[] {
deprecation.warn(
'Blockly.libraryBlocks.procedures.getVars()',
'v13',
'v14',
'Blockly.libraryBlocks.procedures.getVarModels().map(model => model.getName())',
);
return this.arguments_;
},
/**
@@ -1060,7 +1077,8 @@ const PROCEDURE_CALL_COMMON = {
if (
def &&
(def.type !== this.defType_ ||
JSON.stringify(def.getVars()) !== JSON.stringify(this.arguments_))
JSON.stringify(def.getVarModels().map((model) => model.getName())) !==
JSON.stringify(this.arguments_))
) {
// The signatures don't match.
def = null;

9
core/block.ts
View File

@@ -50,6 +50,7 @@ import * as registry from './registry.js';
import * as Tooltip from './tooltip.js';
import * as arrayUtils from './utils/array.js';
import {Coordinate} from './utils/coordinate.js';
import * as deprecation from './utils/deprecation.js';
import * as idGenerator from './utils/idgenerator.js';
import * as parsing from './utils/parsing.js';
import {Size} from './utils/size.js';
@@ -1139,9 +1140,16 @@ export class Block {
/**
* Return all variables referenced by this block.
*
* @deprecated v13: Use Blockly.Block.getVarModels().map(m => m.getId())
* @returns List of variable ids.
*/
getVars(): string[] {
deprecation.warn(
'Blockly.Block.getVars()',
'v13',
'v14',
'Blockly.Block.getVarModels().map(model => model.getId())',
);
const vars: string[] = [];
for (const field of this.getFields()) {
if (field.referencesVariables()) {
@@ -1155,7 +1163,6 @@ export class Block {
* Return all variables referenced by this block.
*
* @returns List of variable models.
* @internal
*/
getVarModels(): IVariableModel<IVariableState>[] {
const vars = [];

2
demos/blockfactory/factory_utils.js
View File

@@ -964,7 +964,7 @@ FactoryUtils.hasVariableField = function(block) {
if (!block) {
return false;
}
return block.getVars().length > 0;
return block.getVarModels().length > 0;
};
/**

6
generators/dart/procedures.ts
View File

@@ -56,9 +56,9 @@ export function procedures_defreturn(block: Block, generator: DartGenerator) {
}
const returnType = returnValue ? 'dynamic' : 'void';
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.getVariableName(variables[i]);
args[i] = generator.getVariableName(variables[i].getId());
}
let code =
returnType +
@@ -92,7 +92,7 @@ export function procedures_callreturn(
// Call a procedure with a return value.
const funcName = generator.getProcedureName(block.getFieldValue('NAME'));
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.valueToCode(block, 'ARG' + i, Order.NONE) || 'null';
}

6
generators/javascript/procedures.ts
View File

@@ -58,9 +58,9 @@ export function procedures_defreturn(
returnValue = generator.INDENT + 'return ' + returnValue + ';\n';
}
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.getVariableName(variables[i]);
args[i] = generator.getVariableName(variables[i].getId());
}
let code =
'function ' +
@@ -93,7 +93,7 @@ export function procedures_callreturn(
// Call a procedure with a return value.
const funcName = generator.getProcedureName(block.getFieldValue('NAME'));
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.valueToCode(block, 'ARG' + i, Order.NONE) || 'null';
}

6
generators/lua/procedures.ts
View File

@@ -60,9 +60,9 @@ export function procedures_defreturn(
branch = '';
}
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.getVariableName(variables[i]);
args[i] = generator.getVariableName(variables[i].getId());
}
let code =
'function ' +
@@ -95,7 +95,7 @@ export function procedures_callreturn(
// Call a procedure with a return value.
const funcName = generator.getProcedureName(block.getFieldValue('NAME'));
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.valueToCode(block, 'ARG' + i, Order.NONE) || 'nil';
}

9
generators/php/procedures.ts
View File

@@ -26,8 +26,7 @@ export function procedures_defreturn(block: Block, generator: PhpGenerator) {
const usedVariables = Variables.allUsedVarModels(workspace) || [];
for (const variable of usedVariables) {
const varName = variable.getName();
// getVars returns parameter names, not ids, for procedure blocks
if (!block.getVars().includes(varName)) {
if (!block.getVarModels().includes(variable)) {
globals.push(generator.getVariableName(varName));
}
}
@@ -80,9 +79,9 @@ export function procedures_defreturn(block: Block, generator: PhpGenerator) {
returnValue = generator.INDENT + 'return ' + returnValue + ';\n';
}
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.getVariableName(variables[i]);
args[i] = generator.getVariableName(variables[i].getId());
}
let code =
'function ' +
@@ -116,7 +115,7 @@ export function procedures_callreturn(
// Call a procedure with a return value.
const funcName = generator.getProcedureName(block.getFieldValue('NAME'));
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.valueToCode(block, 'ARG' + i, Order.NONE) || 'null';
}

9
generators/python/procedures.ts
View File

@@ -26,8 +26,7 @@ export function procedures_defreturn(block: Block, generator: PythonGenerator) {
const usedVariables = Variables.allUsedVarModels(workspace) || [];
for (const variable of usedVariables) {
const varName = variable.getName();
// getVars returns parameter names, not ids, for procedure blocks
if (!block.getVars().includes(varName)) {
if (!block.getVarModels().includes(variable)) {
globals.push(generator.getVariableName(varName));
}
}
@@ -82,9 +81,9 @@ export function procedures_defreturn(block: Block, generator: PythonGenerator) {
branch = generator.PASS;
}
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.getVariableName(variables[i]);
args[i] = generator.getVariableName(variables[i].getId());
}
let code =
'def ' +
@@ -117,7 +116,7 @@ export function procedures_callreturn(
// Call a procedure with a return value.
const funcName = generator.getProcedureName(block.getFieldValue('NAME'));
const args = [];
const variables = block.getVars();
const variables = block.getVarModels();
for (let i = 0; i < variables.length; i++) {
args[i] = generator.valueToCode(block, 'ARG' + i, Order.NONE) || 'None';
}

20
tests/mocha/blocks/procedures_test.js
View File

@@ -1972,22 +1972,14 @@ suite('Procedures', function () {
this.clock.runAll();
}
function assertArgs(argArray) {
assert.equal(
this.defBlock.getVars().length,
argArray.length,
'Expected the def to have the right number of arguments',
assert.deepEqual(
this.defBlock.getVarModels().map((m) => m.getName()),
argArray,
);
for (let i = 0; i < argArray.length; i++) {
assert.equal(this.defBlock.getVars()[i], argArray[i]);
}
assert.equal(
this.callBlock.getVars().length,
argArray.length,
'Expected the call to have the right number of arguments',
assert.deepEqual(
this.callBlock.getVarModels().map((m) => m.getName()),
argArray,
);
for (let i = 0; i < argArray.length; i++) {
assert.equal(this.callBlock.getVars()[i], argArray[i]);
}
}
test('Simple Add Arg', async function () {
const args = ['arg1'];

10
tests/mocha/test_helpers/procedures.js
View File

@@ -47,7 +47,10 @@ function assertCallBlockArgsStructure(callBlock, args) {
'Call block consts did not match expected.',
);
}
assert.sameOrderedMembers(callBlock.getVars(), args);
assert.sameOrderedMembers(
callBlock.getVarModels().map((model) => model.getName()),
args,
);
}
/**
@@ -104,7 +107,10 @@ export function assertDefBlockStructure(
);
}
assert.sameOrderedMembers(defBlock.getVars(), args);
assert.sameOrderedMembers(
defBlock.getVarModels().map((model) => model.getName()),
args,
);
assertBlockVarModels(defBlock, varIds);
}