<Refactor>[Interface Update]: <IPluginAdapter Update>

[Remove a couple of setter;  Then fix the unit tests and the rest of the interfaces]

[#39]

core/IPluginAdapter.py

@@ -1,14 +1,10 @@
 
-from typing import Union
-
 from abc import ABC
 from abc import abstractmethod
 
 from dataclasses import dataclass
 
-from ogl.OglLink import OglLink
-from ogl.OglObject import OglObject
-
+from core.types.Types import OglObjectType
 from core.types.Types import FrameInformationCallback
 from core.types.Types import FrameSizeCallback
 from core.types.Types import PluginProject
@@ -43,11 +39,6 @@ def pyutVersion(self) -> str:
         """
         pass
 
-    @pyutVersion.setter
-    @abstractmethod
-    def pyutVersion(self, newVersion: str):
-        pass
-
     @property
     @abstractmethod
     def screenMetrics(self) -> ScreenMetrics:
@@ -64,16 +55,6 @@ def currentDirectory(self) -> str:
         """
         pass
 
-    @currentDirectory.setter
-    @abstractmethod
-    def currentDirectory(self, theNewValue: str):
-        """
-        TODO:  Should plugins be allowed to manipulate the application's current directory
-        Args:
-            theNewValue:
-        """
-        pass
-
     @abstractmethod
     def getFrameSize(self, callback: FrameSizeCallback):
         pass
@@ -114,9 +95,9 @@ def deselectAllOglObjects(self):
         pass
 
     @abstractmethod
-    def addShape(self, shape: Union[OglObject, OglLink]):
+    def addShape(self, shape: OglObjectType):
         """
-        Add an Ogl shape in the currently displayed frame
+        Add an Ogl shape to the currently displayed frame
         Args:
             shape:
         """

core/PluginInterface.py

@@ -232,7 +232,7 @@ def askForImportDirectoryName(self) -> ImportDirectoryResponse:
         else:
             response.directoryName = dirDialog.GetPath()
             response.cancelled     = False
-            self._pluginAdapter.currentDirectory = response.directoryName    # TODO: Should plugin be doing this?
+            # self._pluginAdapter.currentDirectory = response.directoryName    # TODO: Should plugin be doing this?  No
 
         dirDialog.Destroy()
 
@@ -261,7 +261,7 @@ def askForExportDirectoryName(self, preferredDefaultPath: str = None) -> ExportD
             response.cancelled     = True
         else:
             directory = dirDialog.GetPath()
-            self._pluginAdapter.currentDirectory = directory     # TODO  Should a plugin do this
+            # self._pluginAdapter.currentDirectory = directory     # TODO  Should a plugin do this;  No
             dirDialog.Destroy()
             response.directoryName = directory
 

core/types/Types.py

@@ -17,12 +17,15 @@
 
 from pyutmodel.PyutLink import PyutLink
 
-from ogl.OglActor import OglActor
-from ogl.OglNote import OglNote
 from ogl.OglClass import OglClass
 from ogl.OglLink import OglLink
+from ogl.OglInterface2 import OglInterface2
+from ogl.OglNote import OglNote
 from ogl.OglText import OglText
+
 from ogl.OglUseCase import OglUseCase
+from ogl.OglActor import OglActor
+
 from ogl.sd.OglSDInstance import OglSDInstance
 from ogl.sd.OglSDMessage import OglSDMessage
 
@@ -36,9 +39,9 @@
 OglSDInstances = NewType('OglSDInstances', Dict[int, OglSDInstance])
 OglSDMessages  = NewType('OglSDMessages',  Dict[int, OglSDMessage])
 
-AllOglObjects = Union[OglClasses, OglLinks, OglNotes, OglTexts, OglActors, OglUseCases]
+OglObjectType = Union[OglClass, OglLink, OglNote, OglText, OglActor, OglUseCase, OglInterface2]
 
-OglObjects = NewType('OglObjects',  List[AllOglObjects])
+OglObjects = NewType('OglObjects',  List[OglObjectType])
 PyutLinks  = NewType('PyutLinks',   List[PyutLink])
 
 SelectedOglObjectsCallback = Callable[[OglObjects], None]        # Todo: Figure out appropriate type for callback

plugins/io/IOXml.py

@@ -167,7 +167,8 @@ def write(self, oglObjects: OglObjects):
                 case OglClass() as oglObject:
                     oglDocument.oglClasses.append(oglObject)
                 case OglInterface2() as oglObject:
-                    oglDocument.oglLinks.append(oglObject)
+                    # TODO Fix this in oglio
+                    oglDocument.oglLinks.append(oglObject)  # type: ignore
                 case OglLink() as oglObject:
                     oglDocument.oglLinks.append(oglObject)
                 case OglNote() as oglObject:

setup.py

@@ -11,7 +11,7 @@
 
 setup(
     name="pyutplugincore",
-    version="0.5.8",
+    version="0.5.9",
     author='Humberto A. Sanchez II',
     author_email='[email protected]',
     maintainer='Humberto A. Sanchez II',

tests/MockPluginAdapter.py

@@ -1,5 +1,4 @@
 
-from typing import Union
 from typing import cast
 
 from unittest.mock import MagicMock
@@ -8,13 +7,11 @@
 
 from miniogl.DiagramFrame import DiagramFrame
 
-from ogl.OglLink import OglLink
-from ogl.OglObject import OglObject
-
 from core.IPluginAdapter import IPluginAdapter
 from core.IPluginAdapter import ScreenMetrics
 from core.types.Types import FrameInformationCallback
 from core.types.Types import FrameSizeCallback
+from core.types.Types import OglObjectType
 from core.types.Types import PluginProject
 from core.types.Types import SelectedOglObjectsCallback
 from tests.scaffoldv2.eventengine.EventEngine import EventEngine
@@ -91,7 +88,7 @@ def selectAllOglObjects(self):
     def deselectAllOglObjects(self):
         pass
 
-    def addShape(self, shape: Union[OglObject, OglLink]):
+    def addShape(self, shape: OglObjectType):
         pass
 
     def loadProject(self, pluginProject: PluginProject):

tests/core/SampleIMediator.py

@@ -1,19 +1,23 @@
-from typing import Union
+
 from typing import cast
 
 from logging import Logger
 from logging import getLogger
 
-from ogl.OglLink import OglLink
-from ogl.OglObject import OglObject
+
 from wx import Frame
 
 from miniogl.DiagramFrame import DiagramFrame
 
 from core.IPluginAdapter import IPluginAdapter
 from core.IPluginAdapter import ScreenMetrics
+from core.types.Types import FrameInformationCallback
+from core.types.Types import FrameSizeCallback
+from core.types.Types import OglObjectType
 from core.types.Types import OglObjects
 from core.types.Types import PluginProject
+from core.types.Types import SelectedOglObjectsCallback
+
 from tests.scaffoldv2.eventengine.EventEngine import EventEngine
 
 
@@ -30,10 +34,6 @@ def __init__(self):
     def currentDirectory(self) -> str:
         return self._currentDirectory
 
-    @currentDirectory.setter
-    def currentDirectory(self, newValue: str):
-        self._currentDirectory = newValue
-
     @property
     def umlFrame(self) -> Frame:
         return cast(Frame, None)
@@ -46,10 +46,6 @@ def umlFrame(self, newValue: DiagramFrame):
     def pyutVersion(self) -> str:
         return self._pyutVersion
 
-    @pyutVersion.setter
-    def pyutVersion(self, newVersion: str):
-        pass
-
     @property
     def screenMetrics(self) -> ScreenMetrics:
         return ScreenMetrics(dpiX=72, dpiY=72, screenWidth=250, screenHeight=1440)
@@ -66,6 +62,15 @@ def eventEngine(self, eventEngine: EventEngine):
     def selectedOglObjects(self) -> OglObjects:
         return cast(OglObjects, None)
 
+    def getFrameSize(self, callback: FrameSizeCallback):
+        pass
+
+    def getFrameInformation(self, callback: FrameInformationCallback):
+        pass
+
+    def getSelectedOglObjects(self, callback: SelectedOglObjectsCallback):
+        pass
+
     def refreshFrame(self):
         pass
 
@@ -75,7 +80,7 @@ def selectAllOglObjects(self):
     def deselectAllOglObjects(self):
         pass
 
-    def addShape(self, shape: Union[OglObject, OglLink]):
+    def addShape(self, shape: OglObjectType):
         pass
 
     def loadProject(self, pluginProject: PluginProject):

tests/scaffoldv2/PluginAdapterV2.py

@@ -1,18 +1,14 @@
 
-from typing import Union
-
 from logging import Logger
 from logging import getLogger
 
 from wx import Yield as wxYield
 
-from ogl.OglLink import OglLink
-from ogl.OglObject import OglObject
-
 from core.IPluginAdapter import IPluginAdapter
 from core.IPluginAdapter import ScreenMetrics
 from core.types.Types import FrameInformationCallback
 from core.types.Types import FrameSizeCallback
+from core.types.Types import OglObjectType
 
 from core.types.Types import PluginProject
 from core.types.Types import SelectedOglObjectsCallback
@@ -37,10 +33,6 @@ def __init__(self, eventEngine: IEventEngine):
     def pyutVersion(self) -> str:
         return 'MediatorV2'
 
-    @pyutVersion.setter
-    def pyutVersion(self, newValue: str):
-        self.logger.warning(f'Unused {newValue}')
-
     @property
     def screenMetrics(self) -> ScreenMetrics:
         return ScreenMetrics(dpiX=72, dpiY=72, screenWidth=250, screenHeight=1440)
@@ -52,15 +44,6 @@ def currentDirectory(self) -> str:
         """
         return ''
 
-    @currentDirectory.setter
-    def currentDirectory(self, theNewValue: str):
-        """
-        TODO:  Should plugins be allowed to manipulate the application's current directory
-        Args:
-            theNewValue:
-        """
-        pass
-
     def getFrameSize(self, callback: FrameSizeCallback):
         self._eventEngine.sendEvent(EventType.FrameSize, callback=callback)
 
@@ -81,7 +64,7 @@ def deselectAllOglObjects(self):
         self._eventEngine.sendEvent(EventType.DeSelectAllShapes)
         wxYield()
 
-    def addShape(self, shape: Union[OglObject, OglLink]):
+    def addShape(self, shape: OglObjectType):
         pass
 
     def loadProject(self, pluginProject: PluginProject):