openc3 5.8.1 → 5.9.0

data/lib/openc3/utilities/cli_generator.rb

@@ -18,7 +18,7 @@
 
 module OpenC3
   class CliGenerator
-    GENERATORS = %w(plugin target microservice widget conversion limits_response)
+    GENERATORS = %w(plugin target microservice widget conversion limits_response tool tool_vue tool_angular tool_react tool_svelte)
     TEMPLATES_DIR = "#{File.dirname(__FILE__)}/../../../templates"
 
     # Called by openc3cli with ARGV[1..-1]
@@ -27,18 +27,18 @@ module OpenC3
         abort("Unknown generator '#{args[0]}'. Valid generators: #{GENERATORS.join(', ')}")
       end
       check_args(args)
-      send("generate_#{args[0]}", args)
+      send("generate_#{args[0].to_s.downcase.gsub('-', '_')}", args)
     end
 
     def self.check_args(args)
       args.each do |arg|
         if arg =~ /\s/
-          abort("#{args[0].capitalize} arguments can not have spaces!")
+          abort("#{args[0].to_s.downcase} arguments can not have spaces!") unless args[0].to_s.downcase[0..3] == 'tool'
         end
       end
       # All generators except 'plugin' must be within an existing plugin
       if args[0] != 'plugin' and Dir.glob("*.gemspec").empty?
-        abort("No gemspec file detected. #{args[0].capitalize} generator should be run within an existing plugin.")
+        abort("No gemspec file detected. #{args[0].to_s.downcase} generator should be run within an existing plugin.")
       end
     end
 
@@ -199,6 +199,58 @@ module OpenC3
       return widget_name
     end
 
+    def self.generate_tool(args)
+      if args.length != 2
+        abort("Usage: cli generate #{args[0]} 'Tool Name'")
+      end
+
+      # Create the local variables
+      tool_type = args[0].to_s.downcase.gsub('-', '_')
+      tool_type = 'tool_vue' if tool_type == 'tool'
+      tool_name_display = args[1]
+      tool_name = args[1].to_s.downcase.gsub('-', '').gsub(' ', '')
+      tool_path = "tools/#{tool_name}"
+      if File.exist?(tool_path)
+        abort("Tool #{tool_path} already exists!")
+      end
+      skip_package = false
+      if File.exist?('package.json')
+        puts "package.json already exists ... you'll have to manually add this tool and its dependencies"
+        skip_package = true
+      end
+
+      process_template("#{TEMPLATES_DIR}/#{tool_type}", binding) do |filename|
+        if skip_package && filename == 'package.json'
+          true # causes the block to skip processing this file
+        elsif filename.include?('node_modules')
+          true
+        else
+          filename.gsub!("tool_name", tool_name)
+          false
+        end
+      end
+
+      # Add this tool to plugin.txt
+      js_file = 'main.js'
+      js_file = 'js/app.js' if tool_type == 'tool_vue'
+      File.open("plugin.txt", 'a') do |file|
+        file.puts <<~DOC
+
+        TOOL #{tool_name} "#{tool_name_display}"
+          INLINE_URL #{js_file}
+          ICON mdi-file-cad-box
+        DOC
+      end
+
+      puts "Tool #{tool_name} successfully generated!"
+      puts "Please be sure #{tool_name} does not conflict with any other tools"
+      return tool_name
+    end
+    self.singleton_class.send(:alias_method, :generate_tool_vue, :generate_tool)
+    self.singleton_class.send(:alias_method, :generate_tool_react, :generate_tool)
+    self.singleton_class.send(:alias_method, :generate_tool_angular, :generate_tool)
+    self.singleton_class.send(:alias_method, :generate_tool_svelte, :generate_tool)
+
     def self.generate_conversion(args)
       if args.length != 3
         abort("Usage: cli generate conversion <TARGET> <NAME>")

data/lib/openc3/utilities/ruby_lex_utils.rb

@@ -283,7 +283,10 @@ class RubyLexUtils
           yield line, !contains_keyword?(line), inside_begin, lex.exp_line_no
           line = ''
           lex.exp_line_no = lex.line_no
+          # puts "clear line 1"
           lex.line = ''
+          previous_line_indent = indent
+          continue_indent = nil
           next
         end
       end
@@ -327,6 +330,7 @@ class RubyLexUtils
         end
         line = ''
         lex.exp_line_no = lex.line_no
+        # puts "clear line 2"
         lex.line = ''
         break
       end # loop do

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.8.1'
+OPENC3_VERSION = '5.9.0'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '8'
-    PATCH = '1'
+    MINOR = '9'
+    PATCH = '0'
     OTHER = ''
-    BUILD = 'aa0bd75b6940b719d0fb32814365abd9e0aa6397'
+    BUILD = '7ad48e4189eb35c8a08051cc9856d0bd8be27f60'
   end
-  VERSION = '5.8.1'
-  GEM_VERSION = '5.8.1'
+  VERSION = '5.9.0'
+  GEM_VERSION = '5.9.0'
 end

data/templates/plugin/README.md

@@ -2,15 +2,65 @@
 
 See the [OpenC3](https://openc3.com) documentation for all things OpenC3.
 
-## Building the plugin
+Update this comment with your own description.
 
-1. <Path to COSMOS installation>\openc3.bat cli rake build VERSION=X.Y.Z
+## Getting Started
+
+1. Edit the .gemspec file fields: name, summary, description, authors, email, and homepage
+1. Update the LICENSE.txt file with your company name
+
+## Building non-tool / widget plugins
+
+1. <Path to COSMOS installation>/openc3.sh cli rake build VERSION=X.Y.Z (or openc3.bat for Windows)
    - VERSION is required
    - gem file will be built locally
 
-## Upload plugin
+## Building tool / widget plugins using a local Ruby/Node/Yarn/Rake Environment
+
+1. yarn
+1. rake build VERSION=1.0.0
+
+## Building tool / widget plugins using Docker and the openc3-node container
+
+If you don’t have a local node environment, you can use our openc3-node container to build custom tools and custom widgets
+
+Mac / Linux:
+
+```
+docker run -it -v `pwd`:/openc3/local:z -w /openc3/local docker.io/openc3inc/openc3-node sh
+```
+
+Windows:
+
+```
+docker run -it -v %cd%:/openc3/local -w /openc3/local docker.io/openc3inc/openc3-node sh
+```
 
-1. Go to localhost:2900/tools/admin
+1. yarn
+1. rake build VERSION=1.0.0
+
+## Installing into OpenC3 COSMOS
+
+1. Go to the OpenC3 Admin Tool, Plugins Tab
 1. Click the paperclip icon and choose your plugin.gem file
 1. Fill out plugin parameters
 1. Click Install
+
+## Contributing
+
+We encourage you to contribute to OpenC3!
+
+Contributing is easy.
+
+1. Fork the project
+2. Create a feature branch
+3. Make your changes
+4. Submit a pull request
+
+Before any contributions can be incorporated we do require all contributors to agree to a Contributor License Agreement
+
+This protects both you and us and you retain full rights to any code you write.
+
+## License
+
+This OpenC3 plugin is released under the MIT License. See [LICENSE.txt](LICENSE.txt)

data/templates/plugin/Rakefile

@@ -7,11 +7,39 @@ task :require_version do
   end
 end
 
+# Note: The sh command is built into Rake:
+# https://rubydoc.info/gems/rake/FileUtils#sh-instance_method
 task :build => [:require_version] do
-  # The sh command is built into Rake:
-  # https://rubydoc.info/gems/rake/FileUtils#sh-instance_method
+  _, platform, *_ = RUBY_PLATFORM.split("-")
+  if platform == 'mswin32' or platform == 'mingw32'
+    puts "Warning: Building gem on Windows will lose file permissions"
+  end
+
+  # Run yarn build if we have a package.json
+  if File.exist?('package.json')
+    sh('yarn run build') do |ok, status|
+      raise "yarn run build failed" if !ok
+    end
+  end
+
+  split_version = ENV['VERSION'].to_s.split('.')
+  major = split_version[0]
+  minor = split_version[1]
+  if ENV['VERSION'] =~ /[a-zA-Z]+/
+    # Prerelease version
+    remainder = split_version[2..-1].join(".")
+    remainder.gsub!('-', '.pre.') # Rubygems replaces dashes with .pre.
+    remainder_split = remainder.split('.')
+    patch = remainder_split[0]
+    other = remainder_split[1..-1].join('.')
+    gem_version = "#{major}.#{minor}.#{patch}.#{other}"
+  else
+    gem_version = ENV['VERSION']
+  end
+  gem_name = PLUGIN_NAME + '-' + gem_version + '.gem'
+
   sh('gem', 'build', PLUGIN_NAME)
-  sh('openc3cli validate *.gem') do |ok, status|
+  sh("openc3cli validate #{gem_name}") do |ok, status|
     if !ok && status.exitstatus == 127 # command not found
       puts "Install the openc3 gem to validate! (gem install openc3)"
     end

data/templates/tool_angular/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

data/templates/tool_angular/.gitignore

@@ -0,0 +1,44 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# Compiled output
+/dist
+/tmp
+/out-tsc
+/bazel-out
+
+# Node
+/node_modules
+npm-debug.log
+yarn-error.log
+
+# IDEs and editors
+.idea/
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
+
+# System files
+.DS_Store
+Thumbs.db
+
+tools/*

data/templates/tool_angular/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=827846
+  "recommendations": ["angular.ng-template"]
+}

data/templates/tool_angular/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "ng serve",
+      "type": "chrome",
+      "request": "launch",
+      "preLaunchTask": "npm: start",
+      "url": "http://localhost:4200/"
+    },
+    {
+      "name": "ng test",
+      "type": "chrome",
+      "request": "launch",
+      "preLaunchTask": "npm: test",
+      "url": "http://localhost:9876/debug.html"
+    }
+  ]
+}

data/templates/tool_angular/.vscode/tasks.json

@@ -0,0 +1,42 @@
+{
+  // For more information, visit: https://go.microsoft.com/fwlink/?LinkId=733558
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "start",
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "typescript",
+        "pattern": "$tsc",
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": {
+            "regexp": "(.*?)"
+          },
+          "endsPattern": {
+            "regexp": "bundle generation complete"
+          }
+        }
+      }
+    },
+    {
+      "type": "npm",
+      "script": "test",
+      "isBackground": true,
+      "problemMatcher": {
+        "owner": "typescript",
+        "pattern": "$tsc",
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": {
+            "regexp": "(.*?)"
+          },
+          "endsPattern": {
+            "regexp": "bundle generation complete"
+          }
+        }
+      }
+    }
+  ]
+}

data/templates/tool_angular/angular.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "openc3-tool-<%= tool_name %>": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "openc3-tool-<%= tool_name %>",
+      "architect": {
+        "build": {
+          "builder": "@angular-builders/custom-webpack:browser",
+          "options": {
+            "outputPath": "tools/<%= tool_name %>",
+            "index": "src/index.html",
+            "main": "src/main.single-spa.ts",
+            "polyfills": [
+              "zone.js"
+            ],
+            "tsConfig": "tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ],
+            "styles": [
+              "src/styles.scss"
+            ],
+            "scripts": [],
+            "customWebpackConfig": {
+              "path": "extra-webpack.config.js",
+              "libraryName": "openc3-tool-<%= tool_name %>",
+              "libraryTarget": "system"
+            },
+            "deployUrl": "/tools/<%= tool_name %>"
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "150kb",
+                  "maximumError": "150kb"
+                }
+              ],
+              "outputHashing": "none"
+            },
+            "development": {
+              "buildOptimizer": false,
+              "optimization": false,
+              "vendorChunk": true,
+              "extractLicenses": false,
+              "sourceMap": true,
+              "namedChunks": true,
+              "outputHashing": "none"
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-builders/custom-webpack:dev-server",
+          "configurations": {
+            "production": {
+              "browserTarget": "openc3-tool-<%= tool_name %>:build:production"
+            },
+            "development": {
+              "browserTarget": "openc3-tool-<%= tool_name %>:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "openc3-tool-<%= tool_name %>:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "polyfills": [
+              "zone.js",
+              "zone.js/testing"
+            ],
+            "tsConfig": "tsconfig.spec.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ],
+            "styles": [
+              "src/styles.scss"
+            ],
+            "scripts": []
+          }
+        }
+      }
+    }
+  }
+}

data/templates/tool_angular/extra-webpack.config.js

@@ -0,0 +1,8 @@
+const singleSpaAngularWebpack = require('single-spa-angular/lib/webpack').default;
+
+module.exports = (config, options) => {
+  const singleSpaWebpackConfig = singleSpaAngularWebpack(config, options);
+
+  // Feel free to modify this webpack config however you'd like to
+  return singleSpaWebpackConfig;
+};

data/templates/tool_angular/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "<%= tool_name %>",
+  "version": "5.9.0",
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "watch": "ng build --watch --configuration development",
+    "test": "ng test",
+    "build:single-spa:openc3-tool-template-angular": "ng build openc3-tool-<%= tool_name %> --configuration production",
+    "serve:single-spa:openc3-tool-template-angular": "ng s --project openc3-tool-<%= tool_name %> --disable-host-check --port 4200 --live-reload false"
+  },
+  "private": true,
+  "dependencies": {
+    "@angular/animations": "^16.1.3",
+    "@angular/cdk": "^16.1.3",
+    "@angular/common": "^16.1.3",
+    "@angular/compiler": "^16.1.3",
+    "@angular/core": "^16.1.3",
+    "@angular/forms": "^16.1.3",
+    "@angular/material": "16.1.3",
+    "@angular/platform-browser": "^16.1.3",
+    "@angular/platform-browser-dynamic": "^16.1.3",
+    "@angular/router": "^16.1.3",
+    "@openc3/tool-common": "5.9.0",
+    "rxjs": "~7.8.0",
+    "single-spa": ">=5.9.5",
+    "single-spa-angular": "^8.1.0",
+    "tslib": "^2.6.0",
+    "zone.js": "~0.13.1"
+  },
+  "devDependencies": {
+    "@angular-builders/custom-webpack": "16.0.0",
+    "@angular-devkit/build-angular": "^16.0.5",
+    "@angular/cli": "~16.1.3",
+    "@angular/compiler-cli": "^16.0.0",
+    "@types/jasmine": "~4.3.0",
+    "jasmine-core": "~5.0.1",
+    "karma": "~6.4.0",
+    "karma-chrome-launcher": "~3.2.0",
+    "karma-coverage": "~2.2.0",
+    "karma-jasmine": "~5.1.0",
+    "karma-jasmine-html-reporter": "~2.1.0",
+    "style-loader": "^3.3.1",
+    "typescript": "~5.1.6"
+  }
+}

data/templates/tool_angular/src/app/app-routing.module.ts

@@ -0,0 +1,15 @@
+import { NgModule } from '@angular/core';
+import { RouterModule, Routes } from '@angular/router';
+import {APP_BASE_HREF} from '@angular/common';
+import { EmptyRouteComponent } from './empty-route/empty-route.component';
+
+const routes: Routes = [
+  { path: '**', component: EmptyRouteComponent }
+];
+
+@NgModule({
+  imports: [RouterModule.forRoot(routes)],
+  exports: [RouterModule],
+  providers: [{ provide: APP_BASE_HREF, useValue: '/tools/<%= tool_name %>' }]
+})
+export class AppRoutingModule { }

data/templates/tool_angular/src/app/app.component.html

@@ -0,0 +1,31 @@
+<!-- This menu position hack should only be necessary in the portal -->
+<style>
+::ng-deep .mat-mdc-menu-panel.myMenu {
+  background-color:white;
+  color:black;
+  position:absolute !important;
+  top:0px;
+  left:60px;
+}
+
+.mat-mdc-card {
+  background: white;
+}
+</style>
+
+<div class="content" role="main">
+
+  <mat-card color="accent">
+    <mat-card-content><button mat-raised-button color="primary" (click)="clickHandler()">Send Command</button></mat-card-content>
+  </mat-card>
+
+  <ng-template cdk-portal>
+    <button mat-raised-button [matMenuTriggerFor]="menu">File</button>
+    <mat-menu #menu="matMenu" class="myMenu">
+      <button mat-menu-item (click)="clickHandler()">Send Command</button>
+    </mat-menu>
+    <div style="display: inline-block; width: 80%; text-align: center"><%= tool_name_display %></div>
+  </ng-template>
+</div>
+
+<router-outlet></router-outlet>

data/templates/tool_angular/src/app/app.component.scss

@@ -0,0 +1,26 @@
+@use '@angular/material' as mat;
+
+@include mat.core();
+
+// Define a dark theme
+$dark-theme: mat.define-dark-theme((
+ color: (
+   primary: mat.define-palette(mat.$blue-palette),
+   accent: mat.define-palette(mat.$blue-grey-palette),
+ ),
+  // Only include `typography` and `density` in the default dark theme.
+  typography: mat.define-typography-config(),
+  density: 0,
+));
+
+// Define a light theme
+$light-theme: mat.define-light-theme((
+ color: (
+   primary: mat.define-palette(mat.$indigo-palette),
+   accent: mat.define-palette(mat.$pink-palette),
+ ),
+));
+
+// Apply the dark theme by default
+@include mat.core-theme($dark-theme);
+@include mat.button-theme($dark-theme);

data/templates/tool_angular/src/app/app.component.spec.ts

@@ -0,0 +1,29 @@
+import { TestBed } from '@angular/core/testing';
+import { RouterTestingModule } from '@angular/router/testing';
+import { AppComponent } from './app.component';
+
+describe('AppComponent', () => {
+  beforeEach(() => TestBed.configureTestingModule({
+    imports: [RouterTestingModule],
+    declarations: [AppComponent]
+  }));
+
+  it('should create the app', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.componentInstance;
+    expect(app).toBeTruthy();
+  });
+
+  it(`should have as title 'openc3-tool-<%= tool_name %>'`, () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    const app = fixture.componentInstance;
+    expect(app.title).toEqual('openc3-tool-<%= tool_name %>');
+  });
+
+  it('should render title', () => {
+    const fixture = TestBed.createComponent(AppComponent);
+    fixture.detectChanges();
+    const compiled = fixture.nativeElement as HTMLElement;
+    expect(compiled.querySelector('.content span')?.textContent).toContain('openc3-tool-<%= tool_name %> app is running!');
+  });
+});