refactor

deephaven · Apr 24, 2024 · bf068a6 · bf068a6
1 parent 61d639f
commit bf068a6
Show file tree

Hide file tree

Showing 30 changed files with 47 additions and 43 deletions.
diff --git a/templates/bidirectional-plugin/cookiecutter.json b/templates/bidirectional-plugin/cookiecutter.json
@@ -1,11 +1,18 @@
 {
   "project_name": "deephaven plugin template",
-  "project_slug": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
-  "py_namespace": "plugins.{{cookiecutter.project_slug}}",
-  "py_folder_name": "plugins/{{cookiecutter.project_slug}}",
-  "py_pascal_case": "{{ cookiecutter.project_name.title().replace(' ', '') }}",
-  "py_kebab_case": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
-  "object_name": "plugins.{{ cookiecutter.py_pascal_case }}",
+  "python_project_name": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
+  "javascript_project_name": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
   "author_name": "Anonymous",
-  "author_email": "Anonymous"
+  "author_email": "Anonymous",
+  "__py_namespace": "{{ cookiecutter.python_project_name }}",
+  "__src_folder_name": "{{ cookiecutter.python_project_name }}",
+  "__name_pascal_case": "{{ cookiecutter.python_project_name.replace('_', ' ') .title().replace(' ', '') }}",
+  "__registered_object_name": "{{ cookiecutter.__name_pascal_case }}",
+  "__object_name": "{{ cookiecutter.__name_pascal_case }}Object",
+  "__object_file_name": "{{ cookiecutter.python_project_name }}_object",
+  "__type_name": "{{ cookiecutter.__name_pascal_case }}Type",
+  "__type_file_name": "{{ cookiecutter.python_project_name }}_type",
+  "__message_stream_name": "{{ cookiecutter.__name_pascal_case }}MessageStream",
+  "__js_plugin_obj_name": "{{ cookiecutter.__name_pascal_case }}JsPlugin",
+  "__registration_name": "{{ cookiecutter.__name_pascal_case }}Registration"
 }
diff --git a/...{ cookiecutter.project_slug }}/.gitignore → ...ecutter.python_project_name }}/.gitignore b/...{ cookiecutter.project_slug }}/.gitignore → ...ecutter.python_project_name }}/.gitignore
diff --git a/...n/{{ cookiecutter.project_slug }}/LICENSE → ...okiecutter.python_project_name }}/LICENSE b/...n/{{ cookiecutter.project_slug }}/LICENSE → ...okiecutter.python_project_name }}/LICENSE
diff --git a/...{{ cookiecutter.project_slug }}/README.md → ...iecutter.python_project_name }}/README.md b/...{{ cookiecutter.project_slug }}/README.md → ...iecutter.python_project_name }}/README.md
diff --git a/...okiecutter.project_slug }}/pyproject.toml → ...ter.python_project_name }}/pyproject.toml b/...okiecutter.project_slug }}/pyproject.toml → ...ter.python_project_name }}/pyproject.toml
diff --git a/...{{ cookiecutter.project_slug }}/setup.cfg → ...iecutter.python_project_name }}/setup.cfg b/...{{ cookiecutter.project_slug }}/setup.cfg → ...iecutter.python_project_name }}/setup.cfg
@@ -1,12 +1,12 @@
 [metadata]
-name = {{cookiecutter.project_name}}
+name = {{cookiecutter.python_project_name}}
 description = deephaven plugin
 long_description = file: README.md
 long_description_content_type = text/markdown
 version = 0.0.1.dev0
 keywords = deephaven, plugin, graph
-author = {{cookiecutter.author_name}}
-author_email = {{cookiecutter.author_email}}
+author = {{ cookiecutter.author_name }}
+author_email = {{ cookiecutter.author_email }}
 platforms = any
 
 [options]
@@ -24,4 +24,4 @@ where=src
 
 [options.entry_points]
 deephaven.plugin =
-    registration_cls = {{cookiecutter.py_namespace}}._register:{{cookiecutter.py_pascal_case}}Registration
+    registration_cls = {{ cookiecutter.__py_namespace }}._register:{{ cookiecutter.__registration_name }}
diff --git a/.../{{ cookiecutter.project_slug }}/setup.py → ...kiecutter.python_project_name }}/setup.py b/.../{{ cookiecutter.project_slug }}/setup.py → ...kiecutter.python_project_name }}/setup.py
@@ -3,8 +3,8 @@
 from deephaven.plugin.packaging import package_js
 
 js_dir = "src/js/"
-dest_dir = os.path.join("src/{{cookiecutter.py_folder_name}}/_js")
+dest_dir = os.path.join("src/{{cookiecutter.__src_folder_name}}/_js")
 
 package_js(js_dir, dest_dir)
 
-setup(package_data={"{{cookiecutter.py_namespace}}._js": ["**"]})
+setup(package_data={"{{cookiecutter.__py_namespace}}._js": ["**"]})
diff --git a/...utter.project_slug }}/src/js/.eslintrc.js → ...ython_project_name }}/src/js/.eslintrc.js b/...utter.project_slug }}/src/js/.eslintrc.js → ...ython_project_name }}/src/js/.eslintrc.js
diff --git a/...ecutter.project_slug }}/src/js/.gitignore → ....python_project_name }}/src/js/.gitignore b/...ecutter.project_slug }}/src/js/.gitignore → ....python_project_name }}/src/js/.gitignore
diff --git a/...iecutter.project_slug }}/src/js/README.md → ...r.python_project_name }}/src/js/README.md b/...iecutter.project_slug }}/src/js/README.md → ...r.python_project_name }}/src/js/README.md
diff --git a/....project_slug }}/src/js/package-lock.json → ..._project_name }}/src/js/package-lock.json b/....project_slug }}/src/js/package-lock.json → ..._project_name }}/src/js/package-lock.json
diff --git a/...utter.project_slug }}/src/js/package.json → ...ython_project_name }}/src/js/package.json b/...utter.project_slug }}/src/js/package.json → ...ython_project_name }}/src/js/package.json
@@ -1,11 +1,10 @@
 {
-  "name": "@deephaven/{{ cookiecutter.py_kebab_case }}",
+  "name": "{{ cookiecutter.javascript_project_name }}",
   "version": "0.1.0",
-  "description": "Deephaven plugin",
+  "description": "A plugin for deephaven",
   "keywords": [
     "Deephaven",
-    "plugin",
-    "deephaven-js-plugin"
+    "plugin"
   ],
   "author": "{{ cookiecutter.author_name }}",
   "license": "Apache-2.0",

diff --git a/...oject_slug }}/src/js/src/CustomPanel.scss → ...oject_name }}/src/js/src/CustomPanel.scss b/...oject_slug }}/src/js/src/CustomPanel.scss → ...oject_name }}/src/js/src/CustomPanel.scss
diff --git a/...roject_slug }}/src/js/src/CustomPanel.tsx → ...roject_name }}/src/js/src/CustomPanel.tsx b/...roject_slug }}/src/js/src/CustomPanel.tsx → ...roject_name }}/src/js/src/CustomPanel.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import { DashboardPanelProps } from '@deephaven/dashboard';
 import Log from '@deephaven/log';
 
-const log = Log.module('@deephaven/{{ cookiecutter.py_kebab_case }}.CustomPanel');
+const log = Log.module('{{ cookiecutter.javascript_project_name }}.CustomPanel');
 
 /**
  * Displays a custom panel. Props passed in are determined by your `DashboardPlugin` that registers this panel.
@@ -11,6 +11,6 @@ export function CustomPanel(props: DashboardPanelProps): JSX.Element {
   return <div className="custom-panel">This is a custom panel</div>;
 }
 
-CustomPanel.COMPONENT = '@deephaven/{{ cookiecutter.py_kebab_case }}.CustomPanel';
+CustomPanel.COMPONENT = '{{ cookiecutter.javascript_project_name }}.CustomPanel';
 
 export default CustomPanel;
diff --git a/...ct_slug }}/src/js/src/DashboardPlugin.tsx → ...ct_name }}/src/js/src/DashboardPlugin.tsx b/...ct_slug }}/src/js/src/DashboardPlugin.tsx → ...ct_name }}/src/js/src/DashboardPlugin.tsx
@@ -18,12 +18,12 @@ import styles from './CustomPanel.scss?inline';
 /**
  * Create your own logger module to easily identify where logs are being printed from.
  */
-const log = Log.module('@deephaven/{{ cookiecutter.py_kebab_case }}.DashboardPlugin');
+const log = Log.module('{{ cookiecutter.javascript_project_name }}.DashboardPlugin');
 
 /**
  * Specify a plugin matching an expected custom object type to react to when that object type is opened.
  */
-export const VARIABLE_TYPE = '{{ cookiecutter.object_name }}';
+export const VARIABLE_TYPE = '{{ cookiecutter.__registered_object_name }}';
 
 /**
  * Dashboard Plugin. Registers with a dashboard. The rendered component will be rendered atop the dashboard layout.

diff --git a/...utter.project_slug }}/src/js/src/index.ts → ...ython_project_name }}/src/js/src/index.ts b/...utter.project_slug }}/src/js/src/index.ts → ...ython_project_name }}/src/js/src/index.ts
diff --git a/....project_slug }}/src/js/src/vite-env.d.ts → ..._project_name }}/src/js/src/vite-env.d.ts b/....project_slug }}/src/js/src/vite-env.d.ts → ..._project_name }}/src/js/src/vite-env.d.ts
diff --git a/...tter.project_slug }}/src/js/tsconfig.json → ...thon_project_name }}/src/js/tsconfig.json b/...tter.project_slug }}/src/js/tsconfig.json → ...thon_project_name }}/src/js/tsconfig.json
diff --git a/...ter.project_slug }}/src/js/vite.config.js → ...hon_project_name }}/src/js/vite.config.js b/...ter.project_slug }}/src/js/vite.config.js → ...hon_project_name }}/src/js/vite.config.js
diff --git a/...{ cookiecutter.project_slug }}/.gitignore → ...kiecutter.__src_folder_name }}/.gitignore b/...{ cookiecutter.project_slug }}/.gitignore → ...kiecutter.__src_folder_name }}/.gitignore
diff --git a/... cookiecutter.project_slug }}/__init__.py → ...iecutter.__src_folder_name }}/__init__.py b/... cookiecutter.project_slug }}/__init__.py → ...iecutter.__src_folder_name }}/__init__.py
@@ -4,4 +4,4 @@
 The API is designed to be similar to React, but with some differences to make it more Pythonic.
 """
 
-from .{{cookiecutter.project_slug}}_object import *
+from .{{ cookiecutter.__object_file_name }} import *
diff --git a/...ookiecutter.project_slug }}/_js_plugin.py → ...cutter.__src_folder_name }}/_js_plugin.py b/...ookiecutter.project_slug }}/_js_plugin.py → ...cutter.__src_folder_name }}/_js_plugin.py
@@ -3,7 +3,7 @@
 from deephaven.plugin.js import JsPlugin
 
 
-class {{cookiecutter.py_pascal_case}}JsPlugin(JsPlugin):
+class {{ cookiecutter.__js_plugin_obj_name }}(JsPlugin):
     def __init__(
         self,
         name: str,

diff --git a/...cookiecutter.project_slug }}/_register.py → ...ecutter.__src_folder_name }}/_register.py b/...cookiecutter.project_slug }}/_register.py → ...ecutter.__src_folder_name }}/_register.py
@@ -1,21 +1,21 @@
 from deephaven.plugin import Registration, Callback
 from deephaven.plugin.utilities import create_js_plugin, DheSafeCallbackWrapper
 
-from ._js_plugin import {{ cookiecutter.py_pascal_case }}JsPlugin
-from .{{ cookiecutter.project_slug }}_type import {{ cookiecutter.py_pascal_case }}Type
+from ._js_plugin import {{ cookiecutter.__js_plugin_obj_name }}
+from .{{ cookiecutter.__type_file_name }} import {{ cookiecutter.__type_name }}
 
-PACKAGE_NAMESPACE = "{{cookiecutter.py_namespace}}"
+PACKAGE_NAMESPACE = "{{cookiecutter.__py_namespace}}"
 JS_NAME = "_js"
-PLUGIN_CLASS = {{cookiecutter.py_pascal_case}}JsPlugin
+PLUGIN_CLASS = {{ cookiecutter.__js_plugin_obj_name }}
 
 
-class {{ cookiecutter.py_pascal_case }}Registration(Registration):
+class {{ cookiecutter.__registration_name }}(Registration):
     @classmethod
     def register_into(cls, callback: Callback) -> None:
 
         callback = DheSafeCallbackWrapper(callback)
 
-        callback.register({{ cookiecutter.py_pascal_case }}Type)
+        callback.register({{ cookiecutter.__type_name }})
 
         js_plugin = create_js_plugin(
             PACKAGE_NAMESPACE,

diff --git a/...{{ cookiecutter.project_slug }}_object.py → .../{{ cookiecutter.__object_file_name }}.py b/...{{ cookiecutter.project_slug }}_object.py → .../{{ cookiecutter.__object_file_name }}.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-class {{cookiecutter.py_pascal_case}}Object:
+class {{ cookiecutter.__object_name }}:
     def __init__(self):
         pass
 

diff --git a/...}/{{ cookiecutter.project_slug }}_type.py → ...}}/{{ cookiecutter.__type_file_name }}.py b/...}/{{ cookiecutter.project_slug }}_type.py → ...}}/{{ cookiecutter.__type_file_name }}.py
@@ -3,18 +3,17 @@
 from typing import Any
 from deephaven.plugin.object_type import MessageStream, BidirectionalObjectType
 
-from .{{cookiecutter.project_slug}}_object import {{cookiecutter.py_pascal_case}}Object
+from .{{ cookiecutter.__object_file_name }} import {{ cookiecutter.__object_name }}
 
-class {{cookiecutter.py_pascal_case}}MessageStream(MessageStream):
+class {{ cookiecutter.__message_stream_name }}(MessageStream):
     """
-    Connection for DeephavenFigure
+    A custom MessageStream
 
     Attributes:
-        _listener: DeephavenFigureListener: The listener for the figure
         _client_connection: MessageStream: The connection to the client
     """
 
-    def __init__(self, obj, client_connection: MessageStream):
+    def __init__(self, obj: Any, client_connection: MessageStream):
         super().__init__()
         self._client_connection = client_connection
 
@@ -36,21 +35,20 @@ def on_close(self) -> None:
         pass
 
 
-class {{cookiecutter.py_pascal_case}}Type(BidirectionalObjectType):
+class {{ cookiecutter.__type_name }}(BidirectionalObjectType):
     """
     Defines the Element type for the Deephaven plugin system.
     """
 
     @property
     def name(self) -> str:
-        return "{{ cookiecutter.object_name }}"
+        return "{{ cookiecutter.__registered_object_name }}"
 
     def is_type(self, obj: Any) -> bool:
-        return isinstance(obj, {{cookiecutter.py_pascal_case}}Object)
+        return isinstance(obj, {{ cookiecutter.__object_name }})
 
     def create_client_connection(
         self, obj: object, connection: MessageStream
     ) -> MessageStream:
-        message_stream = {{cookiecutter.py_pascal_case}}MessageStream(obj, connection)
-        #message_stream.on_data(payload, references)
+        message_stream = {{ cookiecutter.__message_stream_name }}(obj, connection)
         return message_stream
diff --git a/...iecutter.project_slug }}/test/__init__.py → ...r.python_project_name }}/test/__init__.py b/...iecutter.project_slug }}/test/__init__.py → ...r.python_project_name }}/test/__init__.py
diff --git a/... cookiecutter.project_slug }}/BaseTest.py → ...cutter.python_project_name }}/BaseTest.py b/... cookiecutter.project_slug }}/BaseTest.py → ...cutter.python_project_name }}/BaseTest.py
diff --git a/... cookiecutter.project_slug }}/__init__.py → ...cutter.python_project_name }}/__init__.py b/... cookiecutter.project_slug }}/__init__.py → ...cutter.python_project_name }}/__init__.py
diff --git a/...s/{{ cookiecutter.project_slug }}/test.py → ...okiecutter.python_project_name }}/test.py b/...s/{{ cookiecutter.project_slug }}/test.py → ...okiecutter.python_project_name }}/test.py
@@ -3,7 +3,7 @@
 
 
 class Test(BaseTestCase):
-    def test_is_table(self):
+    def test(self):
         # since the tests use the embedded server, the import must happen after the tests start
         from deephaven import Table
 

diff --git a/...n/{{ cookiecutter.project_slug }}/tox.ini → ...okiecutter.python_project_name }}/tox.ini b/...n/{{ cookiecutter.project_slug }}/tox.ini → ...okiecutter.python_project_name }}/tox.ini