blockly/tests/mocha/toolbox_helper.js

/**
 * @license
 * Copyright 2020 Google LLC
 * SPDX-License-Identifier: Apache-2.0
 */

goog.module('Blockly.test.toolboxHelpers');


/**
 * Get JSON for a toolbox that contains categories.
 * @return {Blockly.utils.toolbox.ToolboxJson} The array holding information
 *    for a toolbox.
 */
function getCategoryJSON() {
  return {"contents": [
    {
      "kind": "CATEGORY",
      "cssconfig": {
        "container": "something"
      },
      "contents": [
        {
          "kind": "BLOCK",
          "blockxml": '<block type="basic_block"><field name="TEXT">FirstCategory-FirstBlock</field></block>'
        },
        {
          "kind": "BLOCK",
          "blockxml": '<block type="basic_block"><field name="TEXT">FirstCategory-SecondBlock</field></block>'
        }
      ],
      "name": "First"
    },
    {
      "kind": "CATEGORY",
      "contents": [
        {
          "kind": "BLOCK",
          "blockxml": '<block type="basic_block"><field name="TEXT">SecondCategory-FirstBlock</field></block>'
        }
      ],
      "name": "Second"
    }]};
}
exports.getCategoryJSON = getCategoryJSON;

/**
 * Get JSON for a simple toolbox.
 * @return {Blockly.utils.toolbox.ToolboxJson} The array holding information
 *    for a simple toolbox.
 */
function getSimpleJson() {
  return {"contents":[
    {
      "kind":"BLOCK",
      "blockxml":
        `<block type="logic_compare">
          <field name="OP">NEQ</field>
          <value name="A">
            <shadow type="math_number">
              <field name="NUM">1</field>
            </shadow>
          </value>
          <value name="B">
            <block type="math_number">
              <field name="NUM">2</field>
            </block>
          </value>
        </block>`,
    },
    {
      "kind":"SEP",
      "gap":"20"
    },
    {
      "kind":"BUTTON",
      "text": "insert",
      "callbackkey": "insertConnectionRows"
    },
    {
      "kind":"LABEL",
      "text":"tooltips"
    }
  ]};
}
exports.getSimpleJson = getSimpleJson;

function getProperSimpleJson() {
  return {
    "contents": [
      {
        "kind":"BLOCK",
        "type": "logic_compare",
        "fields": {
          "OP": "NEQ",
        },
        "inputs": {
          "A": {
            "shadow": {
              "type": "math_number",
              "fields": {
                "NUM": 1,
              }
            }
          },
          "B": {
            "block": {
              "type": "math_number",
              "fields": {
                "NUM": 2,
              }
            }
          }
        }
      },
      {
        "kind":"SEP",
        "gap":"20"
      },
      {
        "kind":"BUTTON",
        "text": "insert",
        "callbackkey": "insertConnectionRows"
      },
      {
        "kind":"LABEL",
        "text":"tooltips"
      }
    ]};
}
exports.getProperSimpleJson = getProperSimpleJson;

/**
 * Get JSON for a toolbox that contains categories that contain categories.
 * @return {Blockly.utils.toolbox.ToolboxJson} The array holding information
 *    for a toolbox.
 */
function getDeeplyNestedJSON() {
  return {"contents": [
    {
      "kind": "CATEGORY",
      "cssconfig": {
        "container": "something"
      },
      "contents": [{
        "kind": "CATEGORY",
        "contents": [{
          "kind": "CATEGORY",
          "contents": [
            {
              "kind": "BLOCK",
              "blockxml": '<block type="basic_block"><field name="TEXT">NestedCategory-FirstBlock</field></block>'
            },
            {
              "kind": "BLOCK",
              "blockxml": '<block type="basic_block"><field name="TEXT">NestedCategory-SecondBlock</field></block>'
            }
          ],
          "name": "NestedCategoryInner"
        }],
        "name": "NestedCategoryMiddle",
      }],
      "name": "NestedCategoryOuter"
    },
    {
      "kind": "CATEGORY",
      "contents": [
        {
          "kind": "BLOCK",
          "blockxml": '<block type="basic_block"><field name="TEXT">SecondCategory-FirstBlock</field></block>'
        }
      ],
      "name": "Second"
    }]};
}
exports.getDeeplyNestedJSON = getDeeplyNestedJSON;

/**
 * Get an array filled with xml elements.
 * @return {Array<Node>} Array holding xml elements for a toolbox.
 */
function getXmlArray() {
  const block = Blockly.Xml.textToDom(
      `<block type="logic_compare">
        <field name="OP">NEQ</field>
        <value name="A">
          <shadow type="math_number">
            <field name="NUM">1</field>
          </shadow>
        </value>
        <value name="B">
          <block type="math_number">
            <field name="NUM">2</field>
          </block>
        </value>
      </block>`);
  const separator = Blockly.Xml.textToDom('<sep gap="20"></sep>');
  const button = Blockly.Xml.textToDom('<button text="insert" callbackkey="insertConnectionRows"></button>');
  const label = Blockly.Xml.textToDom('<label text="tooltips"></label>');
  return [block, separator, button, label];
}
exports.getXmlArray = getXmlArray;

function getInjectedToolbox() {
  /**
   * Category: First
   *   sep
   *   basic_block
   *   basic_block
   * Category: second
   *   basic_block
   * Category: Variables
   *   custom: VARIABLE
   * Category: NestedCategory
   *   Category: NestedItemOne
   */
  const toolboxXml = document.getElementById('toolbox-test');
  const workspace = Blockly.inject('blocklyDiv',
      {
        toolbox: toolboxXml
      });
  return workspace.getToolbox();
}
exports.getInjectedToolbox = getInjectedToolbox;

function getBasicToolbox() {
  const workspace = new Blockly.WorkspaceSvg(new Blockly.Options({}));
  const toolbox = new Blockly.Toolbox(workspace);
  toolbox.HtmlDiv = document.createElement('div');
  toolbox.flyout_ = sinon.createStubInstance(Blockly.VerticalFlyout);
  return toolbox;
}
exports.getBasicToolbox = getBasicToolbox;

function getCollapsibleItem(toolbox) {
  const contents = toolbox.contents_;
  for (let i = 0; i < contents.length; i++) {
    const item = contents[i];
    if (item.isCollapsible()) {
      return item;
    }
  }
}
exports.getCollapsibleItem = getCollapsibleItem;

function getNonCollapsibleItem(toolbox) {
  const contents = toolbox.contents_;
  for (let i = 0; i < contents.length; i++) {
    const item = contents[i];
    if (!item.isCollapsible()) {
      return item;
    }
  }
}
exports.getNonCollapsibleItem = getNonCollapsibleItem;

function getChildItem(toolbox) {
  return toolbox.getToolboxItemById('nestedCategory');
}
exports.getChildItem = getChildItem;

function getSeparator(toolbox) {
  return toolbox.getToolboxItemById('separator');
}
exports.getSeparator = getSeparator;