Separate the concepts of project and robot. (#143)

* Separate the concepts of project (which is not a module) and a robot, which is a module.
Renamed project to robot where appropriate.
Renamed module to project where appropriate.

* Make the robot's className be "Robot" everywhere, not just in the generated python code.

Added userVisibleName to the commonStorage.Project definition.

* Fixed a few errors and warnings shown in vscode.

Author: lizlooney

README.md

@@ -15,4 +15,3 @@ WARNING! This is not ready for use and is under heavy development of basic featu
 1. Mechanisms aren't limited to init
 2. Mechanisms aren't limited to only Robot or Mechanism class
 3. No way to specify whether an opmode is auto or teleop
-4. Since we changed the "Workspace" terminology to "Project", existing Workspaces are no longer supported. They can be deleted via the browser's Developer Tools - Application tab.

public/locales/en/translation.json

@@ -1,14 +1,14 @@
 {
-    "mechanism_delete": "Delete Project",
-    "mechanism_rename": "Rename Project",
-    "mechanism_copy": "Copy Project",
-    "opmode_delete": "Delete Project",
-    "opmode_rename": "Rename Project",
-    "opmode_copy": "Copy Project",
+    "mechanism_delete": "Delete Mechanism",
+    "mechanism_rename": "Rename Mechanism",
+    "mechanism_copy": "Copy Mechanism",
+    "opmode_delete": "Delete OpMode",
+    "opmode_rename": "Rename OpMode",
+    "opmode_copy": "Copy OpMode",
     "project_delete": "Delete Project",
     "project_rename": "Rename Project",
     "project_copy": "Copy Project",
-    "fail_list_modules": "Failed to load the list of modules.",
+    "fail_list_projects": "Failed to load the list of projects.",
     "mechanism": "Mechanism",
     "opmode": "OpMode",
     "class_rule_description": "No spaces are allowed in the name. Each word in the name should start with a capital letter.",
@@ -21,4 +21,4 @@
         "search": "Search..."
 
     }    
-}
+}

src/App.tsx

@@ -134,8 +134,8 @@ const App: React.FC = (): React.JSX.Element => {
 
     try {
       const value = await storage.fetchEntry(SHOWN_TOOLBOX_CATEGORIES_KEY, DEFAULT_TOOLBOX_CATEGORIES_JSON);
-      const shownCategories: string[] = JSON.parse(value);
-      setShownPythonToolboxCategories(new Set(shownCategories));
+      const shownCategories: Set<string> = new Set(JSON.parse(value));
+      setShownPythonToolboxCategories(shownCategories);
     } catch (e) {
       console.error(TOOLBOX_FETCH_ERROR_MESSAGE);
       console.error(e);
@@ -231,7 +231,7 @@ const App: React.FC = (): React.JSX.Element => {
   const createTabItemsFromProject = (projectData: commonStorage.Project): Tabs.TabItem[] => {
     const tabs: Tabs.TabItem[] = [
       {
-        key: projectData.modulePath,
+        key: projectData.robot.modulePath,
         title: 'Robot',
         type: TabType.ROBOT,
       },
@@ -278,6 +278,10 @@ const App: React.FC = (): React.JSX.Element => {
     initializeBlocks();
   }, []);
 
+  React.useEffect(() => {
+    initializeShownPythonToolboxCategories();
+  }, [storage]);
+
   // Update generator context and load module blocks when current module changes
   React.useEffect(() => {
     if (generatorContext.current) {
@@ -334,7 +338,7 @@ const App: React.FC = (): React.JSX.Element => {
     if (project) {
       const tabs = createTabItemsFromProject(project);
       setTabItems(tabs);
-      setActiveTab(project.modulePath);
+      setActiveTab(project.robot.modulePath);
     }
   }, [project]);
 

src/blocks/mrc_call_python_function.ts

@@ -28,7 +28,6 @@ import { getClassData, getAllowedTypesForSetCheck, getOutputCheck } from './util
 import { FunctionData, findSuperFunctionData } from './utils/python_json_types';
 import * as value from './utils/value';
 import * as variable from './utils/variable';
-import { Editor } from '../editor/editor';
 import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
 import { createFieldDropdown } from '../fields/FieldDropdown';
 import { createFieldNonEditableText } from '../fields/FieldNonEditableText';
@@ -224,9 +223,15 @@ export function addInstanceComponentBlocks(
     contents: toolboxItems.ContentsType[]) {
 
   const classData = getClassData(componentType);
+  if (!classData) {
+    throw new Error('Could not find classData for ' + componentType);
+  }
   const functions = classData.instanceMethods;
 
   const componentClassData = getClassData('component.Component');
+  if (!componentClassData) {
+    throw new Error('Could not find classData for component.Component');
+  }
   const componentFunctions = componentClassData.instanceMethods;
 
   for (const functionData of functions) {
@@ -331,8 +336,7 @@ type CallPythonFunctionExtraState = {
    */
   actualFunctionName?: string,
   /**
-   * True if this blocks refers to an exported function (for example, from a
-   * user's Project).
+   * True if this blocks refers to an exported function (for example, from the Robot).
    */
   exportedFunction?: boolean,
   /**
@@ -540,7 +544,7 @@ const CALL_PYTHON_FUNCTION = {
         case FunctionKind.INSTANCE_COMPONENT: {
           // TODO: We need the list of component names for this.mrcComponentClassName so we can
           // create a dropdown that has the appropriate component names.
-          const componentNames = [];
+          const componentNames: string[] = [];
           const componentName = this.getComponentName();
           if (!componentNames.includes(componentName)) {
             componentNames.push(componentName);
@@ -679,7 +683,7 @@ export const pythonFromBlock = function(
           : block.getFieldValue(FIELD_FUNCTION_NAME);
       // Generate the correct code depending on the module type.
       switch (generator.getModuleType()) {
-        case commonStorage.MODULE_TYPE_PROJECT:
+        case commonStorage.MODULE_TYPE_ROBOT:
         case commonStorage.MODULE_TYPE_MECHANISM:
           code = 'self.';
           break;

src/blocks/mrc_get_python_variable.ts

@@ -228,8 +228,7 @@ type GetPythonVariableExtraState = {
    */
   actualVariableName?: string,
   /**
-   * True if this blocks refers to an exported variable (for example, from a
-   * user's Project).
+   * True if this blocks refers to an exported variable (for example, from the Robot).
    */
   exportedVariable?: boolean,
 };

src/blocks/mrc_set_python_variable.ts

@@ -178,8 +178,7 @@ type SetPythonVariableExtraState = {
    */
   actualVariableName?: string,
   /**
-   * True if this blocks refers to an exported variable (for example, from a
-   * user's Project).
+   * True if this blocks refers to an exported variable (for example, from the Robot).
    */
   exportedVariable?: boolean,
 };

src/blocks/utils/external_samples_data.ts

@@ -19,7 +19,7 @@
  * @author [email protected] (Liz Looney)
  */
 
-import { PythonData, ClassData } from './python_json_types';
+import { PythonData } from './python_json_types';
 import generatedExternalSamplesData from './generated/external_samples_data.json';
 
 export const externalSamplesData = generatedExternalSamplesData as PythonData;

src/blocks/utils/python.ts

@@ -19,7 +19,7 @@
  * @author [email protected] (Liz Looney)
  */
 
-import { PythonData, organizeVarDataByType, VariableGettersAndSetters } from './python_json_types';
+import { ClassData, PythonData, organizeVarDataByType, VariableGettersAndSetters } from './python_json_types';
 import { robotPyData } from './robotpy_data';
 import { externalSamplesData } from './external_samples_data';
 

src/blocks/utils/python_json_types.ts

@@ -123,7 +123,7 @@ function isSuperFunction(f1: FunctionData, f2: FunctionData): boolean {
   return true;
 }
 
-export function findSuperFunctionData(functionData: FunctionData, superClassFunctions: FunctionData): FunctionData | null {
+export function findSuperFunctionData(functionData: FunctionData, superClassFunctions: FunctionData[]): FunctionData | null {
   for (const superClassFunctionData of superClassFunctions) {
     if (isSuperFunction(superClassFunctionData, functionData)) {
       return superClassFunctionData;

src/editor/editor.ts

@@ -45,9 +45,9 @@ export class Editor {
   private eventsCategory: EventsCategory;
   private currentModule: commonStorage.Module | null = null;
   private modulePath: string = '';
-  private projectPath: string = '';
+  private robotPath: string = '';
   private moduleContent: string = '';
-  private projectContent: string = '';
+  private robotContent: string = '';
   private bindedOnChange: any = null;
   private toolbox: Blockly.utils.toolbox.ToolboxDefinition = EMPTY_TOOLBOX;
 
@@ -73,11 +73,11 @@ export class Editor {
 
     // TODO(lizlooney): As blocks are loaded, determine whether any blocks
     // are accessing variable or calling functions thar are defined in another
-    // blocks file (like a Project) and check whether the variable or function
+    // blocks file (like the Robot) and check whether the variable or function
     // definition has changed. This might happen if the user defines a variable
-    // or function in the Project, uses the variable or function in the
+    // or function in the Robot, uses the variable or function in the
     // OpMode, and then removes or changes the variable or function in the
-    // Project.
+    // Robot.
 
     // TODO(lizlooney): We will need a way to identify which variable or
     // function, other than by the variable name or function name, because the
@@ -88,15 +88,15 @@ export class Editor {
     // TODO(lizlooney): Look at blocks with type 'mrc_get_python_variable' or
     // 'mrc_set_python_variable', and where block.mrcExportedVariable === true.
     // Look at block.mrcImportModule and get the exported blocks for that module.
-    // (It should be the project and we already have the project content.)
+    // It could be from the Robot (or a Mechanism?) and we already have the Robot content.
     // Check whether block.mrcActualVariableName matches any exportedBlock's
     // extraState.actualVariableName. If there is no match, put a warning on the
     // block.
 
     // TODO(lizlooney): Look at blocks with type 'mrc_call_python_function' and
     // where block.mrcExportedFunction === true.
     // Look at block.mrcImportModule and get the exported blocks for that module.
-    // (It should be the project and we already have the project content.)
+    // It could be from the Robot (or a Mechanism?) and we already have the Robot content.
     // Check whether block.mrcActualFunctionName matches any exportedBlock's
     // extraState.actualFunctionName. If there is no match, put a warning on the block.
     // If there is a match, check whether
@@ -124,21 +124,23 @@ export class Editor {
 
     if (currentModule) {
       this.modulePath = currentModule.modulePath;
-      this.projectPath = commonStorage.makeProjectPath(currentModule.projectName);
+      this.robotPath = commonStorage.makeRobotPath(currentModule.projectName);
     } else {
       this.modulePath = '';
-      this.projectPath = '';
+      this.robotPath = '';
     }
     this.moduleContent = '';
-    this.projectContent = '';
+    this.robotContent = '';
     this.clearBlocklyWorkspace();
 
     if (currentModule) {
+      // Fetch the content for the current module and the robot.
+      // TODO: Also fetch the content for the mechanisms?
       const promises: {[key: string]: Promise<string>} = {}; // key is module path, value is promise of module content.
       promises[this.modulePath] = this.storage.fetchModuleContent(this.modulePath);
-      if (this.projectPath !== this.modulePath) {
-        // Also fetch the project module content. It contains exported blocks that can be used.
-        promises[this.projectPath] = this.storage.fetchModuleContent(this.projectPath)
+      if (this.robotPath !== this.modulePath) {
+        // Also fetch the robot module content. It contains components, etc, that can be used.
+        promises[this.robotPath] = this.storage.fetchModuleContent(this.robotPath)
       }
 
       const moduleContents: {[key: string]: string} = {}; // key is module path, value is module content
@@ -148,10 +150,10 @@ export class Editor {
         })
       );
       this.moduleContent = moduleContents[this.modulePath];
-      if (this.projectPath === this.modulePath) {
-        this.projectContent = this.moduleContent
+      if (this.robotPath === this.modulePath) {
+        this.robotContent = this.moduleContent
       } else {
-        this.projectContent = moduleContents[this.projectPath];
+        this.robotContent = moduleContents[this.robotPath];
       }
       this.loadBlocksIntoBlocklyWorkspace();
     }
@@ -187,8 +189,8 @@ export class Editor {
 
   public updateToolbox(shownPythonToolboxCategories: Set<string>): void {
     if (this.currentModule) {
-      if (!this.projectContent) {
-        // The Project content hasn't been fetched yet. Try again in a bit.
+      if (!this.robotContent) {
+        // The Robot content hasn't been fetched yet. Try again in a bit.
         setTimeout(() => {
           this.updateToolbox(shownPythonToolboxCategories)
         }, 50);
@@ -229,7 +231,8 @@ export class Editor {
 
   private getComponents(): commonStorage.Component[] {
     const components: commonStorage.Component[] = [];
-    if (this.currentModule?.moduleType === commonStorage.MODULE_TYPE_PROJECT) {
+    if (this.currentModule?.moduleType === commonStorage.MODULE_TYPE_ROBOT ||
+        this.currentModule?.moduleType === commonStorage.MODULE_TYPE_MECHANISM) {
       // TODO(lizlooney): Fill the components array.
     }
     return components;