wip

Author: lizlooney

src/blocks/mrc_class_method_def.ts

@@ -37,6 +37,9 @@ import * as paramContainer from './mrc_param_container'
 
 export const BLOCK_NAME = 'mrc_class_method_def';
 
+const NO_RETURN_VALUE = 'None';
+const UNTYPED_RETURN_VALUE = '';
+
 const INPUT_TITLE = 'TITLE';
 export const FIELD_METHOD_NAME = 'NAME';
 const FIELD_PARAM_PREFIX = 'PARAM_';
@@ -82,8 +85,8 @@ type ClassMethodDefExtraState = {
   canBeCalledOutsideClass: boolean,
   /**
    * The return type of the function.
-   * Use 'None' for no return value.
-   * Use '' for an untyped return value.
+   * Use NO_RETURN_VALUE for no return value.
+   * Use UNTYPED_RETURN_VALUE for an untyped return value.
    */
   returnType: string,
   /**
@@ -252,8 +255,8 @@ const CLASS_METHOD_DEF = {
       this.removeInput(INPUT_RETURN);
     }
 
-    // Add return input if return type is not 'None'
-    if (this.mrcReturnType && this.mrcReturnType !== 'None') {
+    // Add return input if return type is not NO_RETURN_VALUE
+    if (this.mrcReturnType !== undefined && this.mrcReturnType !== NO_RETURN_VALUE) {
       this.appendValueInput(INPUT_RETURN)
           .setAlign(Blockly.inputs.Align.RIGHT)
           .appendField(Blockly.Msg.PROCEDURES_DEFRETURN_RETURN);
@@ -348,6 +351,11 @@ const CLASS_METHOD_DEF = {
       methodBlock.mrcParameters = filteredParams;
     }
   },
+  upgrade_004_to_005: function(this: ClassMethodDefBlock) {
+    if (this.mrcReturnType === 'Any') {
+      this.mrcReturnType = UNTYPED_RETURN_VALUE;
+    }
+  },
 };
 
 /**
@@ -508,7 +516,7 @@ export function createCustomMethodBlock(): toolboxItems.Block {
     canChangeSignature: true,
     canBeCalledWithinClass: true,
     canBeCalledOutsideClass: true,
-    returnType: 'None',
+    returnType: NO_RETURN_VALUE,
     params: [],
   };
   const fields: {[key: string]: any} = {};
@@ -521,7 +529,7 @@ export function createCustomMethodBlockWithReturn(): toolboxItems.Block {
       canChangeSignature: true,
       canBeCalledWithinClass: true,
       canBeCalledOutsideClass: true,
-      returnType: 'Any',
+      returnType: UNTYPED_RETURN_VALUE,
       params: [],
   };
   const fields: {[key: string]: any} = {};

src/storage/upgrade_project.ts

@@ -32,30 +32,40 @@ import { ClassMethodDefBlock, BLOCK_NAME as MRC_CLASS_METHOD_DEF_BLOCK_NAME } fr
 import * as workspaces from '../blocks/utils/workspaces';
 
 export const NO_VERSION = '0.0.0';
-export const CURRENT_VERSION = '0.0.4';
+export const CURRENT_VERSION = '0.0.5';
 
 export async function upgradeProjectIfNecessary(
     storage: commonStorage.Storage, projectName: string): Promise<void> {
   const projectInfo = await storageProject.fetchProjectInfo(storage, projectName);
   if (semver.lt(projectInfo.version, CURRENT_VERSION)) {
     switch (projectInfo.version) {
+      default:
+        throw new Error('Unrecognized project version: ' + projectInfo.version);
+
+      // Intentional fallthrough after case '0.0.0'.
       // @ts-ignore
       case '0.0.0':
         upgradeFrom_000_to_001(storage, projectName, projectInfo)
-      // Intentional fallthrough
+
+      // Intentional fallthrough after case '0.0.1'
       // @ts-ignore
       case '0.0.1':
         upgradeFrom_001_to_002(storage, projectName, projectInfo);
-      // Intentional fallthrough
+
+      // Intentional fallthrough after case '0.0.2'
       // @ts-ignore
       case '0.0.2':
         upgradeFrom_002_to_003(storage, projectName, projectInfo);   
+
+      // Intentional fallthrough after case '0.0.3'
+      // @ts-ignore        
       case '0.0.3':
         upgradeFrom_003_to_004(storage, projectName, projectInfo);
-        break;
-      default:
-        throw new Error('Unrecognized project version: ' + projectInfo.version);
 
+      // Intentional fallthrough after case '0.0.4'
+      // @ts-ignore        
+      case '0.0.4':
+        upgradeFrom_004_to_005(storage, projectName, projectInfo);
     }
     await storageProject.saveProjectInfo(storage, projectName);
   }
@@ -157,3 +167,39 @@ async function upgradeFrom_003_to_004(
   // from loading a project with an older version of software.
   projectInfo.version = '0.0.4';
 }
+
+async function upgradeFrom_004_to_005(
+    storage: commonStorage.Storage,
+    projectName: string,
+    projectInfo: storageProject.ProjectInfo): Promise<void> {
+  // mrc_class_method_def blocks that return a value need to have returnType changed from 'Any' to ''.
+  const projectFileNames: string[] = await storage.list(
+    storageNames.makeProjectDirectoryPath(projectName));
+  for (const projectFileName of projectFileNames) {
+    const modulePath = storageNames.makeFilePath(projectName, projectFileName);
+
+    let moduleContentText = await storage.fetchFileContentText(modulePath);
+    const moduleContent = storageModuleContent.parseModuleContentText(moduleContentText);
+    let blocks = moduleContent.getBlocks();
+
+    // Create a temporary workspace to upgrade the blocks.
+    const headlessWorkspace = workspaces.createHeadlessWorkspace(storageModule.ModuleType.ROBOT);
+
+    try {
+      Blockly.serialization.workspaces.load(blocks, headlessWorkspace);
+
+      // Method blocks need to be upgraded
+      headlessWorkspace.getBlocksByType(MRC_CLASS_METHOD_DEF_BLOCK_NAME, false).forEach(block => {
+        (block as ClassMethodDefBlock).upgrade_004_to_005();
+      });
+      blocks = Blockly.serialization.workspaces.save(headlessWorkspace);
+    } finally {
+      workspaces.destroyHeadlessWorkspace(headlessWorkspace);
+    }
+
+    moduleContent.setBlocks(blocks);
+    moduleContentText = moduleContent.getModuleContentText();
+    await storage.saveFile(modulePath, moduleContentText);
+  }
+  projectInfo.version = '0.0.5';
+}