/** * @license * Copyright 2019 Google LLC * SPDX-License-Identifier: Apache-2.0 */ goog.module('Blockly.test.fieldTextInput'); const {assertFieldValue, runConstructorSuiteTests, runFromJsonSuiteTests, runSetValueTests} = goog.require('Blockly.test.helpers.fields'); const {createTestBlock, defineRowBlock} = goog.require('Blockly.test.helpers.blockDefinitions'); const {sharedTestSetup, sharedTestTeardown, workspaceTeardown} = goog.require('Blockly.test.helpers.setupTeardown'); suite('Text Input Fields', function() { setup(function() { sharedTestSetup.call(this); }); teardown(function() { sharedTestTeardown.call(this); }); /** * Configuration for field tests with invalid values. * @type {!Array} */ const invalidValueTestCases = [ {title: 'Undefined', value: undefined}, {title: 'Null', value: null}, ]; /** * Configuration for field tests with valid values. * @type {!Array} */ const validValueTestCases = [ {title: 'String', value: 'value', expectedValue: 'value'}, {title: 'Boolean true', value: true, expectedValue: 'true'}, {title: 'Boolean false', value: false, expectedValue: 'false'}, {title: 'Number (Truthy)', value: 1, expectedValue: '1'}, {title: 'Number (Falsy)', value: 0, expectedValue: '0'}, {title: 'NaN', value: NaN, expectedValue: 'NaN'}, ]; const addArgsAndJson = function(testCase) { testCase.args = [testCase.value]; testCase.json = {'text': testCase.value}; }; invalidValueTestCases.forEach(addArgsAndJson); validValueTestCases.forEach(addArgsAndJson); /** * The expected default value for the field being tested. * @type {*} */ const defaultFieldValue = ''; /** * Asserts that the field property values are set to default. * @param {!Blockly.FieldTextInput} field The field to check. */ const assertFieldDefault = function(field) { assertFieldValue(field, defaultFieldValue); }; /** * Asserts that the field properties are correct based on the test case. * @param {!Blockly.FieldTextInput} field The field to check. * @param {!FieldValueTestCase} testCase The test case. */ const validTestCaseAssertField = function(field, testCase) { assertFieldValue(field, testCase.expectedValue); }; runConstructorSuiteTests( Blockly.FieldTextInput, validValueTestCases, invalidValueTestCases, validTestCaseAssertField, assertFieldDefault); runFromJsonSuiteTests( Blockly.FieldTextInput, validValueTestCases, invalidValueTestCases, validTestCaseAssertField, assertFieldDefault); suite('setValue', function() { suite('Empty -> New Value', function() { setup(function() { this.field = new Blockly.FieldTextInput(); }); runSetValueTests( validValueTestCases, invalidValueTestCases, defaultFieldValue); test('With source block', function() { this.field.setSourceBlock(createTestBlock()); this.field.setValue('value'); assertFieldValue(this.field, 'value'); }); }); suite('Value -> New Value', function() { const initialValue = 'oldValue'; setup(function() { this.field = new Blockly.FieldTextInput(initialValue); }); runSetValueTests( validValueTestCases, invalidValueTestCases, initialValue); test('With source block', function() { this.field.setSourceBlock(createTestBlock()); this.field.setValue('value'); assertFieldValue(this.field, 'value'); }); }); }); suite('Validators', function() { setup(function() { this.field = new Blockly.FieldTextInput('value'); this.field.htmlInput_ = document.createElement('input'); this.field.htmlInput_.setAttribute('data-old-value', 'value'); this.field.htmlInput_.setAttribute('data-untyped-default-value', 'value'); this.stub = sinon.stub(this.field, 'resizeEditor_'); }); teardown(function() { sinon.restore(); }); const testSuites = [ {title: 'Null Validator', validator: function() { return null; }, value: 'newValue', expectedValue: 'value'}, {title: 'Remove \'a\' Validator', validator: function(newValue) { return newValue.replace(/a/g, ''); }, value: 'bbbaaa', expectedValue: 'bbb'}, {title: 'Returns Undefined Validator', validator: function() {}, value: 'newValue', expectedValue: 'newValue', expectedText: 'newValue'}, ]; testSuites.forEach(function(suiteInfo) { suite(suiteInfo.title, function() { setup(function() { this.field.setValidator(suiteInfo.validator); }); test('When Editing', function() { this.field.isBeingEdited_ = true; this.field.htmlInput_.value = suiteInfo.value; this.field.onHtmlInputChange_(null); assertFieldValue( this.field, suiteInfo.expectedValue, suiteInfo.value); }); test('When Not Editing', function() { this.field.setValue(suiteInfo.value); assertFieldValue(this.field, suiteInfo.expectedValue); }); }); }); }); suite('Customization', function() { suite('Spellcheck', function() { setup(function() { this.prepField = function(field) { const workspace = { getScale: function() { return 1; }, getRenderer: function() { return { getClassName: function() { return ''; }, }; }, getTheme: function() { return { getClassName: function() { return ''; }, }; }, markFocused: function() {}, }; field.sourceBlock_ = { workspace: workspace, }; field.constants_ = { FIELD_TEXT_FONTSIZE: 11, FIELD_TEXT_FONTWEIGHT: 'normal', FIELD_TEXT_FONTFAMILY: 'sans-serif', }; field.clickTarget_ = document.createElement('div'); Blockly.common.setMainWorkspace(workspace); Blockly.WidgetDiv.createDom(); this.stub = sinon.stub(field, 'resizeEditor_'); }; this.assertSpellcheck = function(field, value) { this.prepField(field); field.showEditor_(); chai.assert.equal(field.htmlInput_.getAttribute('spellcheck'), value.toString()); }; }); teardown(function() { if (this.stub) { this.stub.restore(); } }); test('Default', function() { const field = new Blockly.FieldTextInput('test'); this.assertSpellcheck(field, true); }); test('JS Constructor', function() { const field = new Blockly.FieldTextInput('test', null, { spellcheck: false, }); this.assertSpellcheck(field, false); }); test('JSON Definition', function() { const field = Blockly.FieldTextInput.fromJson({ text: 'test', spellcheck: false, }); this.assertSpellcheck(field, false); }); test('setSpellcheck Editor Hidden', function() { const field = new Blockly.FieldTextInput('test'); field.setSpellcheck(false); this.assertSpellcheck(field, false); }); test('setSpellcheck Editor Shown', function() { const field = new Blockly.FieldTextInput('test'); this.prepField(field); field.showEditor_(); field.setSpellcheck(false); chai.assert.equal(field.htmlInput_.getAttribute('spellcheck'), 'false'); }); }); }); suite('Serialization', function() { setup(function() { this.workspace = new Blockly.Workspace(); defineRowBlock(); this.assertValue = (value) => { const block = this.workspace.newBlock('row_block'); const field = new Blockly.FieldTextInput(value); block.getInput('INPUT').appendField(field, 'TEXT'); const jso = Blockly.serialization.blocks.save(block); chai.assert.deepEqual(jso['fields'], {'TEXT': value}); }; }); teardown(function() { workspaceTeardown.call(this, this.workspace); }); test('Simple', function() { this.assertValue('test text'); }); }); });