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

Removing (most) Closure from BlockFactory (#1925)

Browse Source 
Replacing all Closure goog. library calls from BlockFactory, with the exception of the ColorPicker and the test for the warning about running without Closure. This includes (almost) all goog.provide and goog.require statements.
This commit is contained in:
Andrew n marshall
2018-06-15 15:29:41 -07:00
committed by GitHub
parent a87dcc66fb
commit b4cfe263fa
17 changed files with 88 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
demos/blockfactory/analytics.js
View File

@@ -22,7 +22,8 @@
* @fileoverview Stubbed interface functions for analytics integration.
*/
goog.provide('BlocklyDevTools.Analytics');
var BlocklyDevTools = BlocklyDevTools || Object.create(null);
BlocklyDevTools.Analytics = BlocklyDevTools.Analytics || Object.create(null);
/**
* Whether these stub methods should log analytics calls to the console.

41
demos/blockfactory/app_controller.js
View File

@@ -25,17 +25,8 @@
*
* @author quachtina96 (Tina Quach)
*/
goog.provide('AppController');
goog.require('BlockFactory');
goog.require('BlocklyDevTools.Analytics');
goog.require('FactoryUtils');
goog.require('BlockLibraryController');
goog.require('BlockExporterController');
goog.require('goog.dom.classlist');
goog.require('goog.ui.PopupColorPicker');
goog.require('goog.ui.ColorPicker');
goog.require('goog.dom.xml'); // Used to detect Closure
/**
* Controller for the Blockly Factory
@@ -161,9 +152,7 @@ AppController.prototype.exportBlockLibraryToFile = function() {
*/
AppController.prototype.formatBlockLibraryForExport_ = function(blockXmlMap) {
// Create DOM for XML.
var xmlDom = goog.dom.createDom('xml', {
'xmlns':"http://www.w3.org/1999/xhtml"
});
var xmlDom = document.createElementNS('http://www.w3.org/1999/xhtml', 'xml');
// Append each block node to XML DOM.
for (var blockType in blockXmlMap) {
@@ -184,29 +173,25 @@ AppController.prototype.formatBlockLibraryForExport_ = function(blockXmlMap) {
* @private
*/
AppController.prototype.formatBlockLibraryForImport_ = function(xmlText) {
var xmlDom = Blockly.Xml.textToDom(xmlText);
// Get array of XMLs. Use an asterisk (*) instead of a tag name for the XPath
// selector, to match all elements at that level and get all factory_base
// blocks.
var blockNodes = goog.dom.xml.selectNodes(xmlDom, '*');
var inputXml = Blockly.Xml.textToDom(xmlText);
// Convert the live HTMLCollection of child Elements into a static array,
// since the addition to editorWorkspaceXml below removes it from inputXml.
var inputChildren = Array.from(inputXml.children);
// Create empty map. The line below creates a truly empy object. It doesn't
// have built-in attributes/functions such as length or toString.
var blockXmlTextMap = Object.create(null);
// Populate map.
for (var i = 0, blockNode; blockNode = blockNodes[i]; i++) {
for (var i = 0, blockNode; blockNode = inputChildren[i]; i++) {
// Add outer XML tag to the block for proper injection in to the
// main workspace.
// Create DOM for XML.
var xmlDom = goog.dom.createDom('xml', {
'xmlns':"http://www.w3.org/1999/xhtml"
});
xmlDom.appendChild(blockNode);
var editorWorkspaceXml =
document.createElementNS('http://www.w3.org/1999/xhtml', 'xml');
editorWorkspaceXml.appendChild(blockNode);
xmlText = Blockly.Xml.domToText(xmlDom);
xmlText = Blockly.Xml.domToText(editorWorkspaceXml);
// All block types should be lowercase.
var blockType = this.getBlockTypeFromXml_(xmlText).toLowerCase();
// Some names are invalid so fix them up.
@@ -376,9 +361,9 @@ AppController.prototype.onTab = function() {
AppController.prototype.styleTabs_ = function() {
for (var tabName in this.tabMap) {
if (this.selectedTab == tabName) {
goog.dom.classlist.addRemove(this.tabMap[tabName], 'taboff', 'tabon');
this.tabMap[tabName].classList.replace('taboff', 'tabon');
} else {
goog.dom.classlist.addRemove(this.tabMap[tabName], 'tabon', 'taboff');
this.tabMap[tabName].classList.replace('tabon', 'taboff');
}
}
};

39
demos/blockfactory/block_definition_extractor.js
View File

@@ -23,21 +23,15 @@
'use strict';
/**
* Namespace for BlockDefinitionExtractor.
*/
goog.provide('BlockDefinitionExtractor');
/**
* Class to contain all functions needed to extract block definition from
* Namespace to contain all functions needed to extract block definition from
* the block preview data structure.
* @namespace
*/
BlockDefinitionExtractor = BlockDefinitionExtractor || Object.create(null);
var BlockDefinitionExtractor = BlockDefinitionExtractor || Object.create(null);
/**
* Builds a BlockFactory workspace that reflects the block structure of the
* exmaple block.
* example block.
*
* @param {!Blockly.Block} block The reference block from which the definition
* will be extracted.
@@ -45,7 +39,7 @@ BlockDefinitionExtractor = BlockDefinitionExtractor || Object.create(null);
* workspace.
*/
BlockDefinitionExtractor.buildBlockFactoryWorkspace = function(block) {
var workspaceXml = goog.dom.createDom('xml');
var workspaceXml = document.createElement('xml');
workspaceXml.append(
BlockDefinitionExtractor.factoryBase_(block, block.type));
@@ -64,7 +58,7 @@ BlockDefinitionExtractor.buildBlockFactoryWorkspace = function(block) {
*/
BlockDefinitionExtractor.newDomElement_ = function(name, opt_attrs, opt_text) {
// Avoid createDom(..)'s attributes argument for being too HTML specific.
var elem = goog.dom.createDom(name);
var elem = document.createElement(name);
if (opt_attrs) {
for (var key in opt_attrs) {
elem.setAttribute(key, opt_attrs[key]);
@@ -164,16 +158,17 @@ BlockDefinitionExtractor.factoryBase_ = function(block, name) {
factoryBaseEl.append(helpUrlValue);
// Convert colour_ to hue value 0-360 degrees
// TODO(#1247): Solve off-by-one errors.
// TODO: Deal with colors that don't map to standard hues. (Needs improved
// block definitions.)
var colour_hue = Math.floor(
goog.color.hexToHsv(block.colour_)[0]); // Off by one... sometimes
var colourBlock = BlockDefinitionExtractor.colourBlockFromHue_(colour_hue);
var colourInputValue =
BlockDefinitionExtractor.newDomElement_('value', {name: 'COLOUR'});
colourInputValue.append(colourBlock);
factoryBaseEl.append(colourInputValue);
var colour_hue = block.getHue(); // May be null if not set via hue.
if (colour_hue) {
var colourBlock = BlockDefinitionExtractor.colourBlockFromHue_(colour_hue);
var colourInputValue =
BlockDefinitionExtractor.newDomElement_('value', {name: 'COLOUR'});
colourInputValue.append(colourBlock);
factoryBaseEl.append(colourInputValue);
} else {
// Editor will not have a colour block and preview will render black.
// TODO: Support RGB colours in the block editor.
}
return factoryBaseEl;
};
@@ -480,7 +475,7 @@ BlockDefinitionExtractor.buildFieldDropdown_ = function(dropdown) {
var menuGenerator = dropdown.menuGenerator_;
if (typeof menuGenerator === 'function') {
var options = menuGenerator();
} else if (goog.isArray(menuGenerator)) {
} else if (Array.isArray(menuGenerator)) {
var options = menuGenerator;
} else {
throw new Error('Unrecognized type of menuGenerator: ' + menuGenerator);

16
demos/blockfactory/block_exporter_controller.js
View File

@@ -29,22 +29,12 @@
'use strict';
goog.provide('BlockExporterController');
goog.require('BlocklyDevTools.Analytics');
goog.require('FactoryUtils');
goog.require('StandardCategories');
goog.require('BlockExporterView');
goog.require('BlockExporterTools');
goog.require('goog.dom.xml');
/**
* BlockExporter Controller Class
* @param {!BlockLibrary.Storage} blockLibStorage Block Library Storage.
* @constructor
*/
BlockExporterController = function(blockLibStorage) {
function BlockExporterController(blockLibStorage) {
// BlockLibrary.Storage object containing user's saved blocks.
this.blockLibStorage = blockLibStorage;
// Utils for generating code to export.
@@ -132,11 +122,11 @@ BlockExporterController.prototype.export = function() {
BlocklyDevTools.Analytics.onWarning(msg);
alert(msg);
} else {
// Get generator stub code in the selected language for the blocks.
var genStubs = this.tools.getGeneratorCode(blockXmlMap,
language);
// Download the file.
FactoryUtils.createAndDownloadFile(
genStubs, generatorStub_filename + '.js', 'javascript');

57
demos/blockfactory/block_exporter_tools.js
View File

@@ -28,25 +28,15 @@
*/
'use strict';
goog.provide('BlockExporterTools');
goog.require('FactoryUtils');
goog.require('BlockOption');
goog.require('goog.dom');
goog.require('goog.dom.xml');
/**
* Block Exporter Tools Class
* @constructor
*/
BlockExporterTools = function() {
function BlockExporterTools() {
// Create container for hidden workspace.
this.container = goog.dom.createDom('div', {
'id': 'blockExporterTools_hiddenWorkspace'
}, ''); // Empty quotes for empty div.
// Hide hidden workspace.
this.container.style.display = 'none';
this.container = document.createElement('div');
this.container.id = 'blockExporterTools_hiddenWorkspace';
this.container.style.display = 'none'; // Hide the hidden workspace.
document.body.appendChild(this.container);
/**
* Hidden workspace for the Block Exporter that holds pieces that make
@@ -167,45 +157,6 @@ BlockExporterTools.prototype.addBlockDefinitions = function(blockXmlMap) {
eval(blockDefs);
};
/**
* Pulls information about all blocks in the block library to generate XML
* for the selector workpace's toolbox.
* @param {!BlockLibraryStorage} blockLibStorage Block Library Storage object.
* @return {!Element} XML representation of the toolbox.
*/
BlockExporterTools.prototype.generateToolboxFromLibrary
= function(blockLibStorage) {
// Create DOM for XML.
var xmlDom = goog.dom.createDom('xml', {
'id' : 'blockExporterTools_toolbox',
'style' : 'display:none'
});
var allBlockTypes = blockLibStorage.getBlockTypes();
// Object mapping block type to XML.
var blockXmlMap = blockLibStorage.getBlockXmlMap(allBlockTypes);
// Define the custom blocks in order to be able to create instances of
// them in the exporter workspace.
this.addBlockDefinitions(blockXmlMap);
for (var blockType in blockXmlMap) {
// Get block.
var block = FactoryUtils.getDefinedBlock(blockType, this.hiddenWorkspace);
var category = FactoryUtils.generateCategoryXml([block], blockType);
xmlDom.appendChild(category);
}
// If there are no blocks in library and the map is empty, append dummy
// category.
if (Object.keys(blockXmlMap).length == 0) {
var category = goog.dom.createDom('category');
category.setAttribute('name','Next Saved Block');
xmlDom.appendChild(category);
}
return xmlDom;
};
/**
* Generate XML for the workspace factory's category from imported block
* definitions.

9
demos/blockfactory/block_exporter_view.js
View File

@@ -27,19 +27,12 @@
'use strict';
goog.provide('BlockExporterView');
goog.require('BlockExporterTools');
goog.require('BlockOption');
goog.require('goog.dom');
/**
* BlockExporter View Class
* @param {!Object} blockOptions Map of block types to BlockOption objects.
* @constructor
*/
BlockExporterView = function(blockOptions) {
function BlockExporterView(blockOptions) {
// Map of block types to BlockOption objects to select from.
this.blockOptions = blockOptions;
};

12
demos/blockfactory/block_library_controller.js
View File

@@ -32,14 +32,6 @@
*/
'use strict';
goog.provide('BlockLibraryController');
goog.require('BlocklyDevTools.Analytics');
goog.require('BlockLibraryStorage');
goog.require('BlockLibraryView');
goog.require('BlockFactory');
/**
* Block Library Controller Class
* @param {string} blockLibraryName Desired name of Block Library, also used
@@ -48,7 +40,7 @@ goog.require('BlockFactory');
* object that allows user to import a block library.
* @constructor
*/
BlockLibraryController = function(blockLibraryName, opt_blockLibraryStorage) {
function BlockLibraryController(blockLibraryName, opt_blockLibraryStorage) {
this.name = blockLibraryName;
// Create a new, empty Block Library Storage object, or load existing one.
this.storage = opt_blockLibraryStorage || new BlockLibraryStorage(this.name);
@@ -144,7 +136,7 @@ BlockLibraryController.prototype.saveToBlockLibrary = function() {
}
// Create block XML.
var xmlElement = goog.dom.createDom('xml');
var xmlElement = document.createElement('xml');
var block = FactoryUtils.getRootBlock(BlockFactory.mainWorkspace);
xmlElement.appendChild(Blockly.Xml.blockToDomWithXY(block));

11
demos/blockfactory/block_library_storage.js
View File

@@ -27,9 +27,6 @@
'use strict';
goog.provide('BlockLibraryStorage');
/**
* Represents a block library's storage.
* @param {string} blockLibraryName Desired name of Block Library, also used
@@ -37,7 +34,7 @@ goog.provide('BlockLibraryStorage');
* @param {Object} opt_blocks Object mapping block type to XML.
* @constructor
*/
BlockLibraryStorage = function(blockLibraryName, opt_blocks) {
function BlockLibraryStorage(blockLibraryName, opt_blocks) {
// Add prefix to this.name to avoid collisions in local storage.
this.name = 'BlockLibraryStorage.' + blockLibraryName;
if (!opt_blocks) {
@@ -60,9 +57,7 @@ BlockLibraryStorage = function(blockLibraryName, opt_blocks) {
* Reads the named block library from local storage and saves it in this.blocks.
*/
BlockLibraryStorage.prototype.loadFromLocalStorage = function() {
// goog.global is synonymous to window, and allows for flexibility
// between browsers.
var object = goog.global.localStorage[this.name];
var object = localStorage[this.name];
this.blocks = object ? JSON.parse(object) : null;
};
@@ -70,7 +65,7 @@ BlockLibraryStorage.prototype.loadFromLocalStorage = function() {
* Writes the current block library (this.blocks) to local storage.
*/
BlockLibraryStorage.prototype.saveToLocalStorage = function() {
goog.global.localStorage[this.name] = JSON.stringify(this.blocks);
localStorage[this.name] = JSON.stringify(this.blocks);
};
/**

23
demos/blockfactory/block_library_view.js
View File

@@ -27,12 +27,6 @@
'use strict';
goog.provide('BlockLibraryView');
goog.require('goog.dom');
goog.require('goog.dom.classlist');
/**
* BlockLibraryView Class
* @constructor
@@ -59,10 +53,10 @@ var BlockLibraryView = function() {
*/
BlockLibraryView.prototype.addOption = function(blockType, selected) {
// Create option.
var option = goog.dom.createDom('a', {
'id': 'dropdown_' + blockType,
'class': 'blockLibOpt'
}, blockType);
var option = document.createElement('a');
option.id ='dropdown_' + blockType;
option.classList.add('blockLibOpt');
option.textContent = blockType;
// Add option to dropdown.
this.dropdown.appendChild(option);
@@ -99,7 +93,7 @@ BlockLibraryView.prototype.setSelectedBlockType = function(blockTypeToSelect) {
* @private
*/
BlockLibraryView.prototype.selectOption_ = function(option) {
goog.dom.classlist.add(option, 'dropdown-content-selected');
option.classList.add('dropdown-content-selected');
};
/**
@@ -109,7 +103,7 @@ BlockLibraryView.prototype.selectOption_ = function(option) {
* @private
*/
BlockLibraryView.prototype.deselectOption_ = function(option) {
goog.dom.classlist.remove(option, 'dropdown-content-selected');
option.classList.remove('dropdown-content-selected');
};
/**
@@ -150,13 +144,12 @@ BlockLibraryView.prototype.updateButtons =
if (blockType == 'block_type') {
buttonFormatClass = 'button_alert';
}
goog.dom.classlist.add(this.saveButton, buttonFormatClass);
this.saveButton.classList.add(buttonFormatClass);
this.saveButton.disabled = false;
} else {
// No changes to save.
var classesToRemove = ['button_alert', 'button_warn'];
goog.dom.classlist.removeAll(this.saveButton, classesToRemove);
this.saveButton.classList.remove('button_alert', 'button_warn');
this.saveButton.disabled = true;
}

53
demos/blockfactory/block_option.js
View File

@@ -19,18 +19,15 @@
*/
/**
* @fileoverview Javascript for the BlockOption class, used to represent each of
* the various blocks that you may select. Each block option has a checkbox,
* a label, and a preview workspace through which to view the block.
* @fileoverview Javascript for the BlockOption class, used to represent each
* of the various blocks that you may select in the Block Selector. Each block
* option has a checkbox, a label, and a preview workspace through which to
* view the block.
*
* @author quachtina96 (Tina Quach)
*/
'use strict';
goog.provide('BlockOption');
goog.require('goog.dom');
/**
* BlockOption Class
* A block option includes checkbox, label, and div element that shows a preview
@@ -70,48 +67,42 @@ var BlockOption = function(blockSelector, blockType, previewBlockXml) {
*/
BlockOption.prototype.createDom = function() {
// Create the div for the block option.
var blockOptContainer = goog.dom.createDom('div', {
'id': this.blockType,
'class': 'blockOption'
}, ''); // Empty quotes for empty div.
var blockOptContainer = document.createElement('div');
blockOptContainer.id = this.blockType;
blockOptContainer.classList.add('blockOption');
// Create and append div in which to inject the workspace for viewing the
// block option.
var blockOptionPreview = goog.dom.createDom('div', {
'id' : this.blockType + '_workspace',
'class': 'blockOption_preview'
}, '');
var blockOptionPreview = document.createElement('div');
blockOptionPreview.id = this.blockType + '_workspace';
blockOptionPreview.classList.add('blockOption_preview');
blockOptContainer.appendChild(blockOptionPreview);
// Create and append container to hold checkbox and label.
var checkLabelContainer = goog.dom.createDom('div', {
'class': 'blockOption_checkLabel'
}, '');
var checkLabelContainer = document.createElement('div');
checkLabelContainer.classList.add('blockOption_checkLabel');
blockOptContainer.appendChild(checkLabelContainer);
// Create and append container for checkbox.
var checkContainer = goog.dom.createDom('div', {
'class': 'blockOption_check'
}, '');
var checkContainer = document.createElement('div');
checkContainer.classList.add('blockOption_check');
checkLabelContainer.appendChild(checkContainer);
// Create and append checkbox.
this.checkbox = goog.dom.createDom('input', {
'type': 'checkbox',
'id': this.blockType + '_check'
}, '');
this.checkbox = document.createElement('input');
this.checkbox.id = this.blockType + '_check';
this.checkbox.setAttribute('type', 'checkbox');
checkContainer.appendChild(this.checkbox);
// Create and append container for block label.
var labelContainer = goog.dom.createDom('div', {
'class': 'blockOption_label'
}, '');
var labelContainer = document.createElement('div');
labelContainer.classList.add('blockOption_label');
checkLabelContainer.appendChild(labelContainer);
// Create and append text node for the label.
var labelText = goog.dom.createDom('p', {
'id': this.blockType + '_text'
}, this.blockType);
var labelText = document.createElement('p');
labelText.id = this.blockType + '_text';
labelText.textContent = this.blockType;
labelContainer.appendChild(labelText);
this.dom = blockOptContainer;

5
demos/blockfactory/factory.js
View File

@@ -32,10 +32,7 @@
/**
* Namespace for Block Factory.
*/
goog.provide('BlockFactory');
goog.require('FactoryUtils');
goog.require('StandardCategories');
var BlockFactory = BlockFactory || Object.create(null);
/**
* Workspace for user to build block.

9
demos/blockfactory/factory_utils.js
View File

@@ -32,10 +32,7 @@
/**
* Namespace for FactoryUtils.
*/
goog.provide('FactoryUtils');
goog.require('BlockDefinitionExtractor');
var FactoryUtils = FactoryUtils || Object.create(null);
/**
* Get block definition code for the current block.
@@ -768,7 +765,7 @@ FactoryUtils.getBlockTypeFromJsDefinition = function(blockDef) {
*/
FactoryUtils.generateCategoryXml = function(blocks, categoryName) {
// Create category DOM element.
var categoryElement = goog.dom.createDom('category');
var categoryElement = document.createElement('category');
categoryElement.setAttribute('name', categoryName);
// For each block, add block element to category.
@@ -892,7 +889,7 @@ FactoryUtils.injectCode = function(code, id) {
pre.textContent = code;
code = pre.textContent;
code = PR.prettyPrintOne(code, 'js');
pre.innerHTML = code;
pre.textContent = code;
};
/**

2
demos/blockfactory/standard_categories.js
View File

@@ -32,7 +32,7 @@
/**
* Namespace for StandardCategories
*/
goog.provide('StandardCategories');
var StandardCategories = StandardCategories || Object.create(null);
// Map of standard category information necessary to add a standard category

5
demos/blockfactory/workspacefactory/wfactory_controller.js
View File

@@ -34,11 +34,6 @@
* @author Emma Dauterman (evd2014)
*/
goog.require('BlocklyDevTools.Analytics');
goog.require('FactoryUtils');
goog.require('StandardCategories');
/**
* Class for a WorkspaceFactoryController
* @param {string} toolboxName Name of workspace toolbox XML.

15
demos/blockfactory/workspacefactory/wfactory_generator.js
View File

@@ -28,8 +28,6 @@
* @author Emma Dauterman (evd2014)
*/
goog.require('FactoryUtils');
/**
* Class for a WorkspaceFactoryGenerator
@@ -61,11 +59,10 @@ WorkspaceFactoryGenerator = function(model) {
*/
WorkspaceFactoryGenerator.prototype.generateToolboxXml = function() {
// Create DOM for XML.
var xmlDom = goog.dom.createDom('xml',
{
'id' : 'toolbox',
'style' : 'display:none'
});
var xmlDom = document.createElement('xml');
xmlDom.id = 'toolbox';
xmlDom.style.display = 'none';
if (!this.model.hasElements()) {
// Toolbox has no categories. Use XML directly from workspace.
this.loadToHiddenWorkspace_(this.model.getSelectedXml());
@@ -88,10 +85,10 @@ WorkspaceFactoryGenerator.prototype.generateToolboxXml = function() {
var element = toolboxList[i];
if (element.type == ListElement.TYPE_SEPARATOR) {
// If the next element is a separator.
var nextElement = goog.dom.createDom('sep');
var nextElement = document.createElement('sep');
} else if (element.type == ListElement.TYPE_CATEGORY) {
// If the next element is a category.
var nextElement = goog.dom.createDom('category');
var nextElement = document.createElement('category');
nextElement.setAttribute('name', element.name);
// Add a colour attribute if one exists.
if (element.color != null) {

3
demos/blockfactory/workspacefactory/wfactory_init.js
View File

@@ -27,7 +27,8 @@
* @author Emma Dauterman (evd2014)
*/
goog.require('FactoryUtils');
goog.require('goog.ui.PopupColorPicker');
goog.require('goog.ui.ColorPicker');
/**
* Namespace for workspace factory initialization methods.

1
demos/blockfactory/workspacefactory/wfactory_view.js
View File

@@ -28,7 +28,6 @@
* @author Emma Dauterman (edauterman)
*/
goog.require('FactoryUtils');
/**
* Class for a WorkspaceFactoryView