Added field_label_serializable

[BeksOmega]

The basics

• I branched from develop
• My pull request is against develop
• My code follows the style guide

The details

Resolves

Work on #1623
Extension of PR #2389

Proposed Changes

Adds a field_label_serializable field. Which is a label field that can be modified programmatically and saved to XMl.

Also adds an option to the block factory to turn a field_label into a field_label_serializable.

I can also change it to be a separate block if you think that makes more sense.

Reason for Changes

Makes it so developers don't have to create a serializable label field themselves, they can just use the prebuilt one.

Test Coverage

Added an XML test to the mocha to make sure it serializes properly.

I also added a test block to the playground with a button to help test the serialization:

I also tested that blockfactory generates correct json and javascript.

JSON, not serializable:

{
  "type": "block_type",
  "message0": "test text",
  "colour": 230,
  "tooltip": "",
  "helpUrl": ""
}

JSON, serializable:

{
  "type": "block_type",
  "message0": "%1",
  "args0": [
    {
      "type": "field_label_serializable",
      "name": "TESTNAME",
      "text": "test text"
    }
  ],
  "colour": 230,
  "tooltip": "",
  "helpUrl": ""
}

JavaScript, not serializable:

Blockly.Blocks['block_type'] = {
  init: function() {
    this.appendDummyInput()
        .appendField("test text");
    this.setColour(230);
 this.setTooltip("");
 this.setHelpUrl("");
  }
};

JavaScript, serializable:

Blockly.Blocks['block_type'] = {
  init: function() {
    this.appendDummyInput()
        .appendField(new Blockly.FieldLabelSerializable("test text"), "TESTNAME");
    this.setColour(230);
 this.setTooltip("");
 this.setHelpUrl("");
  }
};

Tested on:

• Desktop Chrome

Additional Information

[RoboErikG]

Looks pretty good. I'd prefer this be a separate block in the factory for two reasons:

1. Modifying the existing block means you need to test migration paths (loading old block definitions).
2. It's something else developers need to think about even if they aren't using serializable labels.

[RoboErikG]

2019

[RoboErikG]

Nit: update comment

[BeksOmega]

Changed & retested code generation.

[RoboErikG]

Last comment then lgtm.

[RoboErikG]

Oh, missed this. Please upload a rebuilt compressed file instead of swapping it.

[BeksOmega]

Gah I meant to do that!

[BeksOmega]

So the new field_label_serializable isn't required by any other scripts at the moment, which I think is making it so closure doesn't include it in the compressed file. Should I try to export it? or is there a different solution?

[RoboErikG]

You need to add a goog.require for the new field type to blockly.js.

Side note: You can see a require for FieldDate commented out in that file which is what keeps it from being included in Blockly by default since the date picker is a relatively large dependency.

[BeksOmega]

Rebuilt and retested!