CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-07 09:00:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: allow overriding comment icons (#7937)

Browse Source 
* feat: add comment icon interface

* feat: have blocks construct comment icons from registry

* chore: add tests for setCommentText

* fix: typeguard
This commit is contained in:
Beka Westberg
2024-03-15 18:20:08 +00:00
committed by GitHub
parent e91dd203c3
commit 8821c83cc9
4 changed files with 147 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
tests/mocha/block_test.js
View File

@@ -19,6 +19,7 @@ import {
createMockEvent,
} from './test_helpers/events.js';
import {MockIcon, MockBubbleIcon} from './test_helpers/icon_mocks.js';
import {IconType} from '../../build/src/core/icons/icon_types.js';
suite('Blocks', function () {
setup(function () {
@@ -1367,6 +1368,93 @@ suite('Blocks', function () {
});
});
});
suite('Constructing registered comment classes', function () {
class MockComment extends MockIcon {
getType() {
return Blockly.icons.IconType.COMMENT;
}
setText() {}
getText() {
return '';
}
setBubbleSize() {}
getBubbleSize() {
return Blockly.utils.Size(0, 0);
}
bubbleIsVisible() {
return true;
}
setBubbleVisible() {}
}
setup(function () {
this.workspace = Blockly.inject('blocklyDiv', {});
this.block = this.workspace.newBlock('stack_block');
this.block.initSvg();
this.block.render();
});
teardown(function () {
workspaceTeardown.call(this, this.workspace);
Blockly.icons.registry.unregister(
Blockly.icons.IconType.COMMENT.toString(),
);
Blockly.icons.registry.register(
Blockly.icons.IconType.COMMENT,
Blockly.icons.CommentIcon,
);
});
test('setCommentText constructs the registered comment icon', function () {
Blockly.icons.registry.unregister(
Blockly.icons.IconType.COMMENT.toString(),
);
Blockly.icons.registry.register(
Blockly.icons.IconType.COMMENT,
MockComment,
);
this.block.setCommentText('test text');
chai.assert.instanceOf(
this.block.getIcon(Blockly.icons.IconType.COMMENT),
MockComment,
);
});
test('setCommentText throws if no icon is registered', function () {
Blockly.icons.registry.unregister(
Blockly.icons.IconType.COMMENT.toString(),
);
chai.assert.throws(() => {
this.block.setCommentText('test text');
}, 'No comment icon class is registered, so a comment cannot be set');
});
test('setCommentText throws if the icon is not an ICommentIcon', function () {
Blockly.icons.registry.unregister(
Blockly.icons.IconType.COMMENT.toString(),
);
Blockly.icons.registry.register(
Blockly.icons.IconType.COMMENT,
MockIcon,
);
chai.assert.throws(() => {
this.block.setCommentText('test text');
}, 'The class registered as a comment icon does not conform to the ICommentIcon interface');
});
});
});
suite('Getting/Setting Field (Values)', function () {