mirror of
https://github.com/google/blockly.git
synced 2026-01-21 15:57:10 +01:00
9e5df6216a
* Moved comment icons to use a model-based system. The block holds the model of the comment, and the comment icon holds a reference to it. * Reorganized the setVisible function. * Changed how xml.js serializes and deserializes comments.
547 lines
19 KiB
JavaScript
547 lines
19 KiB
JavaScript
/**
|
|
* @license
|
|
* Visual Blocks Editor
|
|
*
|
|
* Copyright 2019 Google Inc.
|
|
* https://developers.google.com/blockly/
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
suite('Blocks', function() {
|
|
setup(function() {
|
|
this.workspace = new Blockly.Workspace();
|
|
});
|
|
teardown(function() {
|
|
this.workspace.dispose();
|
|
});
|
|
|
|
suite('Connection Management', function() {
|
|
setup(function() {
|
|
Blockly.defineBlocksWithJsonArray([{
|
|
"type": "stack_block",
|
|
"message0": "",
|
|
"previousStatement": null,
|
|
"nextStatement": null
|
|
},
|
|
{
|
|
"type": "row_block",
|
|
"message0": "%1",
|
|
"args0": [
|
|
{
|
|
"type": "input_value",
|
|
"name": "INPUT"
|
|
}
|
|
],
|
|
"output": null
|
|
}]);
|
|
});
|
|
teardown(function() {
|
|
delete Blockly.Blocks['stack_block'];
|
|
delete Blockly.Blocks['row_block'];
|
|
});
|
|
|
|
suite('Unplug', function() {
|
|
function assertUnpluggedNoheal(blocks) {
|
|
// A has nothing connected to it.
|
|
assertEquals(0, blocks.A.getChildren().length);
|
|
// B and C are still connected.
|
|
assertEquals(blocks.B, blocks.C.getParent());
|
|
// B is the top of its stack.
|
|
assertNull(blocks.B.getParent());
|
|
}
|
|
function assertUnpluggedHealed(blocks) {
|
|
// A and C are connected.
|
|
assertEquals(1, blocks.A.getChildren().length);
|
|
assertEquals(blocks.A, blocks.C.getParent());
|
|
// B has nothing connected to it.
|
|
assertEquals(0, blocks.B.getChildren().length);
|
|
// B is the top of its stack.
|
|
assertNull(blocks.B.getParent());
|
|
}
|
|
|
|
suite('Row', function() {
|
|
setup(function() {
|
|
var blockA = this.workspace.newBlock('row_block');
|
|
var blockB = this.workspace.newBlock('row_block');
|
|
var blockC = this.workspace.newBlock('row_block');
|
|
|
|
blockA.inputList[0].connection.connect(blockB.outputConnection);
|
|
blockB.inputList[0].connection.connect(blockC.outputConnection);
|
|
|
|
assertEquals(blockB, blockC.getParent());
|
|
|
|
this.blocks = {
|
|
A: blockA,
|
|
B: blockB,
|
|
C: blockC
|
|
};
|
|
});
|
|
|
|
test('Don\'t heal', function() {
|
|
this.blocks.B.unplug(false);
|
|
assertUnpluggedNoheal(this.blocks);
|
|
});
|
|
test('Heal', function() {
|
|
this.blocks.B.unplug(true);
|
|
// Each block has only one input, and the types work.
|
|
assertUnpluggedHealed(this.blocks);
|
|
});
|
|
test('Heal with bad checks', function() {
|
|
var blocks = this.blocks;
|
|
|
|
// A and C can't connect, but both can connect to B.
|
|
blocks.A.inputList[0].connection.setCheck('type1');
|
|
blocks.C.outputConnection.setCheck('type2');
|
|
|
|
// Each block has only one input, but the types don't work.
|
|
blocks.B.unplug(true);
|
|
assertUnpluggedNoheal(blocks);
|
|
});
|
|
test('A has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to parent
|
|
blocks.A.appendValueInput("INPUT").setCheck(null);
|
|
blocks.B.unplug(true);
|
|
assertUnpluggedHealed(blocks);
|
|
});
|
|
test('B has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to middle block
|
|
blocks.B.appendValueInput("INPUT").setCheck(null);
|
|
blocks.B.unplug(true);
|
|
assertUnpluggedHealed(blocks);
|
|
});
|
|
test('C has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to child block
|
|
blocks.C.appendValueInput("INPUT").setCheck(null);
|
|
// Child block input count doesn't matter.
|
|
blocks.B.unplug(true);
|
|
assertUnpluggedHealed(blocks);
|
|
});
|
|
test('C is Shadow', function() {
|
|
var blocks = this.blocks;
|
|
blocks.C.setShadow(true);
|
|
blocks.B.unplug(true);
|
|
// Even though we're asking to heal, it will appear as if it has not
|
|
// healed because shadows always stay with the parent.
|
|
assertUnpluggedNoheal(blocks);
|
|
});
|
|
});
|
|
suite('Stack', function() {
|
|
setup(function() {
|
|
var blockA = this.workspace.newBlock('stack_block');
|
|
var blockB = this.workspace.newBlock('stack_block');
|
|
var blockC = this.workspace.newBlock('stack_block');
|
|
|
|
blockA.nextConnection.connect(blockB.previousConnection);
|
|
blockB.nextConnection.connect(blockC.previousConnection);
|
|
|
|
assertEquals(blockB, blockC.getParent());
|
|
|
|
this.blocks = {
|
|
A: blockA,
|
|
B: blockB,
|
|
C: blockC
|
|
};
|
|
});
|
|
|
|
test('Don\'t heal', function() {
|
|
this.blocks.B.unplug();
|
|
assertUnpluggedNoheal(this.blocks);
|
|
});
|
|
test('Heal', function() {
|
|
this.blocks.B.unplug(true);
|
|
assertUnpluggedHealed(this.blocks);
|
|
});
|
|
test.skip('Heal with bad checks', function() {
|
|
var blocks = this.blocks;
|
|
// A and C can't connect, but both can connect to B.
|
|
blocks.A.nextConnection.setCheck('type1');
|
|
blocks.C.previousConnection.setCheck('type2');
|
|
|
|
// The types don't work.
|
|
blocks.B.unplug(true);
|
|
|
|
// TODO (#1994): Check types before unplugging. Currently
|
|
// everything disconnects, when C should stick with B
|
|
assertUnpluggedNoheal();
|
|
});
|
|
test('C is Shadow', function() {
|
|
var blocks = this.blocks;
|
|
blocks.C.setShadow(true);
|
|
blocks.B.unplug(true);
|
|
// Even though we're asking to heal, it will appear as if it has not
|
|
// healed because shadows always stay with the parent.
|
|
assertUnpluggedNoheal(blocks);
|
|
});
|
|
});
|
|
});
|
|
suite('Dispose', function() {
|
|
function assertDisposedNoheal(blocks) {
|
|
chai.assert.isFalse(blocks.A.disposed);
|
|
// A has nothing connected to it.
|
|
chai.assert.equal(0, blocks.A.getChildren().length);
|
|
// B is disposed.
|
|
chai.assert.isTrue(blocks.B.disposed);
|
|
// And C is disposed.
|
|
chai.assert.isTrue(blocks.C.disposed);
|
|
}
|
|
function assertDisposedHealed(blocks) {
|
|
chai.assert.isFalse(blocks.A.disposed);
|
|
chai.assert.isFalse(blocks.C.disposed);
|
|
// A and C are connected.
|
|
assertEquals(1, blocks.A.getChildren().length);
|
|
assertEquals(blocks.A, blocks.C.getParent());
|
|
// B is disposed.
|
|
chai.assert.isTrue(blocks.B.disposed);
|
|
}
|
|
|
|
suite('Row', function() {
|
|
setup(function() {
|
|
var blockA = this.workspace.newBlock('row_block');
|
|
var blockB = this.workspace.newBlock('row_block');
|
|
var blockC = this.workspace.newBlock('row_block');
|
|
|
|
blockA.inputList[0].connection.connect(blockB.outputConnection);
|
|
blockB.inputList[0].connection.connect(blockC.outputConnection);
|
|
|
|
assertEquals(blockB, blockC.getParent());
|
|
|
|
this.blocks = {
|
|
A: blockA,
|
|
B: blockB,
|
|
C: blockC
|
|
};
|
|
});
|
|
|
|
test('Don\'t heal', function() {
|
|
this.blocks.B.dispose(false);
|
|
assertDisposedNoheal(this.blocks);
|
|
});
|
|
test('Heal', function() {
|
|
this.blocks.B.dispose(true);
|
|
// Each block has only one input, and the types work.
|
|
assertDisposedHealed(this.blocks);
|
|
});
|
|
test('Heal with bad checks', function() {
|
|
var blocks = this.blocks;
|
|
|
|
// A and C can't connect, but both can connect to B.
|
|
blocks.A.inputList[0].connection.setCheck('type1');
|
|
blocks.C.outputConnection.setCheck('type2');
|
|
|
|
// Each block has only one input, but the types don't work.
|
|
blocks.B.dispose(true);
|
|
assertDisposedNoheal(blocks);
|
|
});
|
|
test('A has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to parent
|
|
blocks.A.appendValueInput("INPUT").setCheck(null);
|
|
blocks.B.dispose(true);
|
|
assertDisposedHealed(blocks);
|
|
});
|
|
test('B has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to middle block
|
|
blocks.B.appendValueInput("INPUT").setCheck(null);
|
|
blocks.B.dispose(true);
|
|
assertDisposedHealed(blocks);
|
|
});
|
|
test('C has multiple inputs', function() {
|
|
var blocks = this.blocks;
|
|
// Add extra input to child block
|
|
blocks.C.appendValueInput("INPUT").setCheck(null);
|
|
// Child block input count doesn't matter.
|
|
blocks.B.dispose(true);
|
|
assertDisposedHealed(blocks);
|
|
});
|
|
test('C is Shadow', function() {
|
|
var blocks = this.blocks;
|
|
blocks.C.setShadow(true);
|
|
blocks.B.dispose(true);
|
|
// Even though we're asking to heal, it will appear as if it has not
|
|
// healed because shadows always get destroyed.
|
|
assertDisposedNoheal(blocks);
|
|
});
|
|
});
|
|
suite('Stack', function() {
|
|
setup(function() {
|
|
var blockA = this.workspace.newBlock('stack_block');
|
|
var blockB = this.workspace.newBlock('stack_block');
|
|
var blockC = this.workspace.newBlock('stack_block');
|
|
|
|
blockA.nextConnection.connect(blockB.previousConnection);
|
|
blockB.nextConnection.connect(blockC.previousConnection);
|
|
|
|
assertEquals(blockB, blockC.getParent());
|
|
|
|
this.blocks = {
|
|
A: blockA,
|
|
B: blockB,
|
|
C: blockC
|
|
};
|
|
});
|
|
|
|
test('Don\'t heal', function() {
|
|
this.blocks.B.dispose();
|
|
assertDisposedNoheal(this.blocks);
|
|
});
|
|
test('Heal', function() {
|
|
this.blocks.B.dispose(true);
|
|
assertDisposedHealed(this.blocks);
|
|
});
|
|
test.skip('Heal with bad checks', function() {
|
|
var blocks = this.blocks;
|
|
// A and C can't connect, but both can connect to B.
|
|
blocks.A.nextConnection.setCheck('type1');
|
|
blocks.C.previousConnection.setCheck('type2');
|
|
|
|
// The types don't work.
|
|
blocks.B.dispose(true);
|
|
|
|
// TODO (#1994): Check types before unplugging. Current C gets
|
|
// left behind when it should get disposed with B.
|
|
assertDisposedNoheal(blocks);
|
|
});
|
|
test('C is Shadow', function() {
|
|
var blocks = this.blocks;
|
|
blocks.C.setShadow(true);
|
|
blocks.B.dispose(true);
|
|
// Even though we're asking to heal, it will appear as if it has not
|
|
// healed because shadows always get destroyed.
|
|
assertDisposedNoheal(blocks);
|
|
});
|
|
});
|
|
});
|
|
suite('Remove Input', function() {
|
|
setup(function() {
|
|
Blockly.defineBlocksWithJsonArray([
|
|
{
|
|
"type": "value_block",
|
|
"message0": "%1",
|
|
"args0": [
|
|
{
|
|
"type": "input_value",
|
|
"name": "VALUE"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "statement_block",
|
|
"message0": "%1",
|
|
"args0": [
|
|
{
|
|
"type": "input_statement",
|
|
"name": "STATEMENT"
|
|
}
|
|
]
|
|
},
|
|
]);
|
|
});
|
|
teardown(function() {
|
|
delete Blockly.Blocks['value_block'];
|
|
delete Blockly.Blocks['statement_block'];
|
|
});
|
|
|
|
suite('Value', function() {
|
|
setup(function() {
|
|
this.blockA = this.workspace.newBlock('value_block');
|
|
});
|
|
|
|
test('No Connected', function() {
|
|
this.blockA.removeInput('VALUE');
|
|
chai.assert.isNull(this.blockA.getInput('VALUE'));
|
|
});
|
|
test('Block Connected', function() {
|
|
var blockB = this.workspace.newBlock('row_block');
|
|
this.blockA.getInput('VALUE').connection
|
|
.connect(blockB.outputConnection);
|
|
|
|
this.blockA.removeInput('VALUE');
|
|
chai.assert.isFalse(blockB.disposed);
|
|
chai.assert.equal(this.blockA.getChildren().length, 0);
|
|
});
|
|
test('Shadow Connected', function() {
|
|
var blockB = this.workspace.newBlock('row_block');
|
|
blockB.setShadow(true);
|
|
this.blockA.getInput('VALUE').connection
|
|
.connect(blockB.outputConnection);
|
|
|
|
this.blockA.removeInput('VALUE');
|
|
chai.assert.isTrue(blockB.disposed);
|
|
chai.assert.equal(this.blockA.getChildren().length, 0);
|
|
});
|
|
});
|
|
suite('Statement', function() {
|
|
setup(function() {
|
|
this.blockA = this.workspace.newBlock('statement_block');
|
|
});
|
|
|
|
test('No Connected', function() {
|
|
this.blockA.removeInput('STATEMENT');
|
|
chai.assert.isNull(this.blockA.getInput('STATEMENT'));
|
|
});
|
|
test('Block Connected', function() {
|
|
var blockB = this.workspace.newBlock('stack_block');
|
|
this.blockA.getInput('STATEMENT').connection
|
|
.connect(blockB.previousConnection);
|
|
|
|
this.blockA.removeInput('STATEMENT');
|
|
chai.assert.isFalse(blockB.disposed);
|
|
chai.assert.equal(this.blockA.getChildren().length, 0);
|
|
});
|
|
test('Shadow Connected', function() {
|
|
var blockB = this.workspace.newBlock('stack_block');
|
|
blockB.setShadow(true);
|
|
this.blockA.getInput('STATEMENT').connection
|
|
.connect(blockB.previousConnection);
|
|
|
|
this.blockA.removeInput('STATEMENT');
|
|
chai.assert.isTrue(blockB.disposed);
|
|
chai.assert.equal(this.blockA.getChildren().length, 0);
|
|
});
|
|
});
|
|
});
|
|
});
|
|
suite('Comments', function() {
|
|
setup(function() {
|
|
Blockly.defineBlocksWithJsonArray([
|
|
{
|
|
"type": "empty_block",
|
|
"message0": "",
|
|
"args0": []
|
|
},
|
|
]);
|
|
this.eventSpy = sinon.spy(Blockly.Events, 'fire');
|
|
});
|
|
teardown(function() {
|
|
delete Blockly.Blocks['empty_block'];
|
|
this.eventSpy.restore();
|
|
});
|
|
suite('Set/Get Text', function() {
|
|
function assertCommentEvent(eventSpy, oldValue, newValue) {
|
|
var calls = eventSpy.getCalls();
|
|
var event = calls[calls.length - 1].args[0];
|
|
chai.assert.equal(event.type, Blockly.Events.BLOCK_CHANGE);
|
|
chai.assert.equal(event.element, 'comment');
|
|
chai.assert.equal(event.oldValue, oldValue);
|
|
chai.assert.equal(event.newValue, newValue);
|
|
}
|
|
function assertNoCommentEvent(eventSpy) {
|
|
var calls = eventSpy.getCalls();
|
|
var event = calls[calls.length - 1].args[0];
|
|
chai.assert.notEqual(event.type, Blockly.Events.BLOCK_CHANGE);
|
|
}
|
|
suite('Headless', function() {
|
|
setup(function() {
|
|
this.block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
|
|
'<block type="empty_block"/>'
|
|
), this.workspace);
|
|
});
|
|
test('Text', function() {
|
|
this.block.setCommentText('test text');
|
|
chai.assert.equal(this.block.getCommentText(), 'test text');
|
|
assertCommentEvent(this.eventSpy, null, 'test text');
|
|
});
|
|
test('Text Empty', function() {
|
|
this.block.setCommentText('');
|
|
chai.assert.equal(this.block.getCommentText(), '');
|
|
assertCommentEvent(this.eventSpy, null, '');
|
|
});
|
|
test('Text Null', function() {
|
|
this.block.setCommentText(null);
|
|
chai.assert.equal(this.block.getCommentText(), null);
|
|
assertNoCommentEvent(this.eventSpy);
|
|
});
|
|
test('Text -> Null', function() {
|
|
this.block.setCommentText('first text');
|
|
|
|
this.block.setCommentText(null);
|
|
chai.assert.equal(this.block.getCommentText(), null);
|
|
assertCommentEvent(this.eventSpy, 'first text', null);
|
|
});
|
|
});
|
|
suite('Rendered', function() {
|
|
setup(function() {
|
|
// Let the parent teardown take care of this.
|
|
this.workspace = Blockly.inject('blocklyDiv', {
|
|
comments: true,
|
|
scrollbars: true
|
|
});
|
|
this.block = Blockly.Xml.domToBlock(Blockly.Xml.textToDom(
|
|
'<block type="empty_block"/>'
|
|
), this.workspace);
|
|
});
|
|
test('Text', function() {
|
|
this.block.setCommentText('test text');
|
|
chai.assert.equal(this.block.getCommentText(), 'test text');
|
|
assertCommentEvent(this.eventSpy, null, 'test text');
|
|
});
|
|
test('Text Empty', function() {
|
|
this.block.setCommentText('');
|
|
chai.assert.equal(this.block.getCommentText(), '');
|
|
assertCommentEvent(this.eventSpy, null, '');
|
|
});
|
|
test('Text Null', function() {
|
|
this.block.setCommentText(null);
|
|
chai.assert.equal(this.block.getCommentText(), null);
|
|
assertNoCommentEvent(this.eventSpy);
|
|
});
|
|
test('Text -> Null', function() {
|
|
this.block.setCommentText('first text');
|
|
|
|
this.block.setCommentText(null);
|
|
chai.assert.equal(this.block.getCommentText(), null);
|
|
assertCommentEvent(this.eventSpy, 'first text', null);
|
|
});
|
|
test('Set While Visible - Editable', function() {
|
|
this.block.setCommentText('test1');
|
|
var icon = this.block.getCommentIcon();
|
|
icon.setVisible(true);
|
|
|
|
this.block.setCommentText('test2');
|
|
chai.assert.equal(this.block.getCommentText(), 'test2');
|
|
assertCommentEvent(this.eventSpy, 'test1', 'test2');
|
|
chai.assert.equal(icon.textarea_.value, 'test2');
|
|
});
|
|
test('Set While Visible - NonEditable', function() {
|
|
this.block.setCommentText('test1');
|
|
var editableStub = sinon.stub(this.block, 'isEditable').returns(false);
|
|
var icon = this.block.getCommentIcon();
|
|
icon.setVisible(true);
|
|
|
|
this.block.setCommentText('test2');
|
|
chai.assert.equal(this.block.getCommentText(), 'test2');
|
|
assertCommentEvent(this.eventSpy, 'test1', 'test2');
|
|
chai.assert.equal(icon.paragraphElement_.firstChild.textContent,
|
|
'test2');
|
|
|
|
editableStub.restore();
|
|
});
|
|
test('Get Text While Editing', function() {
|
|
this.block.setCommentText('test1');
|
|
var icon = this.block.getCommentIcon();
|
|
icon.setVisible(true);
|
|
icon.textarea_.value = 'test2';
|
|
icon.textarea_.dispatchEvent(new Event('input'));
|
|
|
|
chai.assert.equal(this.block.getCommentText(), 'test2');
|
|
});
|
|
});
|
|
});
|
|
});
|
|
});
|