buildzr 0.0.11__py3-none-any.whl → 0.0.12__py3-none-any.whl

buildzr/__about__.py

@@ -1 +1 @@
-VERSION = "0.0.11"
+VERSION = "0.0.12"

buildzr/dsl/dsl.py

@@ -29,7 +29,6 @@ from buildzr.dsl.interfaces import (
     DslWorkspaceElement,
     DslElement,
     DslViewElement,
-    DslViewsElement,
 )
 from buildzr.dsl.relations import (
     DslElementRelationOverrides,
@@ -181,13 +180,43 @@ class Workspace(DslWorkspaceElement):
         else:
             raise ValueError('Invalid element type: Trying to add an element of type {} to a workspace.'.format(type(model)))
 
-    def apply_views( self, *views: Union[ 'SystemLandscapeView',
+    def apply_view(
+        self,
+        view: Union[
+            'SystemLandscapeView',
             'SystemContextView',
             'ContainerView',
             'ComponentView',
         ]
     ) -> None:
-        Views(self).add_views(*views)
+
+        view._on_added(self)
+
+        if not self.model.views:
+            self.model.views = buildzr.models.Views()
+
+        if isinstance(view, SystemLandscapeView):
+            if not self.model.views.systemLandscapeViews:
+                self.model.views.systemLandscapeViews = [view.model]
+            else:
+                self.model.views.systemLandscapeViews.append(view.model)
+        elif isinstance(view, SystemContextView):
+            if not self.model.views.systemContextViews:
+                self.model.views.systemContextViews = [view.model]
+            else:
+                self.model.views.systemContextViews.append(view.model)
+        elif isinstance(view, ContainerView):
+            if not self.model.views.containerViews:
+                self.model.views.containerViews = [view.model]
+            else:
+                self.model.views.containerViews.append(view.model)
+        elif isinstance(view, ComponentView):
+            if not self.model.views.componentViews:
+                self.model.views.componentViews = [view.model]
+            else:
+                self.model.views.componentViews.append(view.model)
+        else:
+            raise NotImplementedError("The view {0} is currently not supported", type(view))
 
     def apply_style( self,
         style: Union['StyleElements', 'StyleRelationships'],
@@ -273,7 +302,7 @@ class SoftwareSystem(DslElementRelationOverrides[
         return self._destinations
 
     @property
-    def relationships(self) -> Set[_Relationship]:
+    def relationships(self) -> Set[DslRelationship]:
         return self._relationships
 
     @property
@@ -287,7 +316,7 @@ class SoftwareSystem(DslElementRelationOverrides[
         self._children: Optional[List['Container']] = []
         self._sources: List[DslElement] = []
         self._destinations: List[DslElement] = []
-        self._relationships: Set[_Relationship] = set()
+        self._relationships: Set[DslRelationship] = set()
         self._tags = {'Element', 'Software System'}.union(tags)
         self._dynamic_attrs: Dict[str, 'Container'] = {}
         self._label: Optional[str] = None
@@ -387,7 +416,7 @@ class Person(DslElementRelationOverrides[
         return self._destinations
 
     @property
-    def relationships(self) -> Set[_Relationship]:
+    def relationships(self) -> Set[DslRelationship]:
         return self._relationships
 
     @property
@@ -399,7 +428,7 @@ class Person(DslElementRelationOverrides[
         self._parent: Optional[Workspace] = None
         self._sources: List[DslElement] = []
         self._destinations: List[DslElement] = []
-        self._relationships: Set[_Relationship] = set()
+        self._relationships: Set[DslRelationship] = set()
         self._tags = {'Element', 'Person'}.union(tags)
         self._label: Optional[str] = None
         self.model.id = GenerateId.for_element()
@@ -458,7 +487,7 @@ class Container(DslElementRelationOverrides[
         return self._destinations
 
     @property
-    def relationships(self) -> Set[_Relationship]:
+    def relationships(self) -> Set[DslRelationship]:
         return self._relationships
 
     @property
@@ -472,7 +501,7 @@ class Container(DslElementRelationOverrides[
         self._children: Optional[List['Component']] = []
         self._sources: List[DslElement] = []
         self._destinations: List[DslElement] = []
-        self._relationships: Set[_Relationship] = set()
+        self._relationships: Set[DslRelationship] = set()
         self._tags = {'Element', 'Container'}.union(tags)
         self._dynamic_attrs: Dict[str, 'Component'] = {}
         self._label: Optional[str] = None
@@ -570,7 +599,7 @@ class Component(DslElementRelationOverrides[
         return self._destinations
 
     @property
-    def relationships(self) -> Set[_Relationship]:
+    def relationships(self) -> Set[DslRelationship]:
         return self._relationships
 
     @property
@@ -582,7 +611,7 @@ class Component(DslElementRelationOverrides[
         self._parent: Optional[Container] = None
         self._sources: List[DslElement] = []
         self._destinations: List[DslElement] = []
-        self._relationships: Set[_Relationship] = set()
+        self._relationships: Set[DslRelationship] = set()
         self._tags = {'Element', 'Component'}.union(tags)
         self._label: Optional[str] = None
         self.model.id = GenerateId.for_element()
@@ -744,10 +773,6 @@ class SystemLandscapeView(DslViewElement):
     def model(self) -> buildzr.models.SystemLandscapeView:
         return self._m
 
-    @property
-    def parent(self) -> Optional['Views']:
-        return self._parent
-
     def __init__(
         self,
         key: str,
@@ -761,7 +786,6 @@ class SystemLandscapeView(DslViewElement):
         properties: Optional[Dict[str, str]]=None,
     ) -> None:
         self._m = buildzr.models.SystemLandscapeView()
-        self._parent: Optional['Views'] = None
 
         self._m.key = key
         self._m.description = description
@@ -777,9 +801,9 @@ class SystemLandscapeView(DslViewElement):
 
         workspace = _current_workspace.get()
         if workspace is not None:
-            workspace.apply_views(self)
+            workspace.apply_view(self)
 
-    def _on_added(self) -> None:
+    def _on_added(self, workspace: Workspace) -> None:
 
         from buildzr.dsl.expression import Expression, Element, Relationship
         from buildzr.models import ElementView, RelationshipView
@@ -791,8 +815,6 @@ class SystemLandscapeView(DslViewElement):
             exclude_relationships=self._exclude_relationships,
         )
 
-        workspace = self._parent._parent
-
         include_view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
             lambda w, e: e.type == Person,
             lambda w, e: e.type == SoftwareSystem
@@ -848,10 +870,6 @@ class SystemContextView(DslViewElement):
     def model(self) -> buildzr.models.SystemContextView:
         return self._m
 
-    @property
-    def parent(self) -> Optional['Views']:
-        return self._parent
-
     def __init__(
         self,
         software_system_selector: Union[SoftwareSystem, Callable[[Workspace], SoftwareSystem]],
@@ -866,7 +884,6 @@ class SystemContextView(DslViewElement):
         properties: Optional[Dict[str, str]]=None,
     ) -> None:
         self._m = buildzr.models.SystemContextView()
-        self._parent: Optional['Views'] = None
 
         self._m.key = key
         self._m.description = description
@@ -883,9 +900,9 @@ class SystemContextView(DslViewElement):
 
         workspace = _current_workspace.get()
         if workspace is not None:
-            workspace.apply_views(self)
+            workspace.apply_view(self)
 
-    def _on_added(self) -> None:
+    def _on_added(self, workspace: Workspace) -> None:
 
         from buildzr.dsl.expression import Expression, Element, Relationship
         from buildzr.models import ElementView, RelationshipView
@@ -893,7 +910,7 @@ class SystemContextView(DslViewElement):
         if isinstance(self._selector, SoftwareSystem):
             software_system = self._selector
         else:
-            software_system = self._selector(self._parent._parent)
+            software_system = self._selector(workspace)
         self._m.softwareSystemId = software_system.model.id
         view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
             lambda w, e: e == software_system,
@@ -913,8 +930,6 @@ class SystemContextView(DslViewElement):
             exclude_relationships=self._exclude_relationships,
         )
 
-        workspace = self._parent._parent
-
         element_ids = map(
             lambda x: str(x.model.id),
             expression.elements(workspace)
@@ -941,10 +956,6 @@ class ContainerView(DslViewElement):
     def model(self) -> buildzr.models.ContainerView:
         return self._m
 
-    @property
-    def parent(self) -> Optional['Views']:
-        return self._parent
-
     def __init__(
         self,
         software_system_selector: Union[SoftwareSystem, Callable[[Workspace], SoftwareSystem]],
@@ -959,7 +970,6 @@ class ContainerView(DslViewElement):
         properties: Optional[Dict[str, str]]=None,
     ) -> None:
         self._m = buildzr.models.ContainerView()
-        self._parent: Optional['Views'] = None
 
         self._m.key = key
         self._m.description = description
@@ -976,9 +986,9 @@ class ContainerView(DslViewElement):
 
         workspace = _current_workspace.get()
         if workspace is not None:
-            workspace.apply_views(self)
+            workspace.apply_view(self)
 
-    def _on_added(self) -> None:
+    def _on_added(self, workspace: Workspace) -> None:
 
         from buildzr.dsl.expression import Expression, Element, Relationship
         from buildzr.models import ElementView, RelationshipView
@@ -986,7 +996,7 @@ class ContainerView(DslViewElement):
         if isinstance(self._selector, SoftwareSystem):
             software_system = self._selector
         else:
-            software_system = self._selector(self._parent._parent)
+            software_system = self._selector(workspace)
         self._m.softwareSystemId = software_system.model.id
 
         container_ids = { container.model.id for container in software_system.children}
@@ -1009,8 +1019,6 @@ class ContainerView(DslViewElement):
             exclude_relationships=self._exclude_relationships,
         )
 
-        workspace = self._parent._parent
-
         element_ids = map(
             lambda x: str(x.model.id),
             expression.elements(workspace)
@@ -1037,10 +1045,6 @@ class ComponentView(DslViewElement):
     def model(self) -> buildzr.models.ComponentView:
         return self._m
 
-    @property
-    def parent(self) -> Optional['Views']:
-        return self._parent
-
     def __init__(
         self,
         container_selector: Union[Container, Callable[[Workspace], Container]],
@@ -1055,7 +1059,6 @@ class ComponentView(DslViewElement):
         properties: Optional[Dict[str, str]]=None,
     ) -> None:
         self._m = buildzr.models.ComponentView()
-        self._parent: Optional['Views'] = None
 
         self._m.key = key
         self._m.description = description
@@ -1072,9 +1075,9 @@ class ComponentView(DslViewElement):
 
         workspace = _current_workspace.get()
         if workspace is not None:
-            workspace.apply_views(self)
+            workspace.apply_view(self)
 
-    def _on_added(self) -> None:
+    def _on_added(self, workspace: Workspace) -> None:
 
         from buildzr.dsl.expression import Expression, Element, Relationship
         from buildzr.models import ElementView, RelationshipView
@@ -1082,7 +1085,7 @@ class ComponentView(DslViewElement):
         if isinstance(self._selector, Container):
             container = self._selector
         else:
-            container = self._selector(self._parent._parent)
+            container = self._selector(workspace)
         self._m.containerId = container.model.id
 
         component_ids = { component.model.id for component in container.children }
@@ -1105,8 +1108,6 @@ class ComponentView(DslViewElement):
             exclude_relationships=self._exclude_relationships,
         )
 
-        workspace = self._parent._parent
-
         element_ids = map(
             lambda x: str(x.model.id),
             expression.elements(workspace)
@@ -1125,70 +1126,6 @@ class ComponentView(DslViewElement):
         for relationship_id in relationship_ids:
             self._m.relationships.append(RelationshipView(id=relationship_id))
 
-class Views(DslViewsElement):
-
-    # TODO: Make this view a "hidden" class -- it's not a "first class citizen"
-    # in buildzr DSL.
-
-    @property
-    def model(self) -> buildzr.models.Views:
-        return self._m
-
-    @property
-    def parent(self) -> Optional[Workspace]:
-        return self._parent
-
-    def __init__(
-        self,
-        workspace: Workspace,
-    ) -> None:
-        self._m = buildzr.models.Views()
-        self._parent = workspace
-        self._parent._m.views = self._m
-
-    def add_views(
-        self,
-        *views: DslViewElement
-    ) -> None:
-
-        for view in views:
-            if isinstance(view, SystemLandscapeView):
-                view._parent = self
-                view._on_added()
-                if self._m.systemLandscapeViews:
-                    self._m.systemLandscapeViews.append(view.model)
-                else:
-                    self._m.systemLandscapeViews = [view.model]
-            elif isinstance(view, SystemContextView):
-                view._parent = self
-                view._on_added()
-                if self._m.systemContextViews:
-                    self._m.systemContextViews.append(view.model)
-                else:
-                    self._m.systemContextViews = [view.model]
-            elif isinstance(view, ContainerView):
-                view._parent = self
-                view._on_added()
-                if self._m.containerViews:
-                    self._m.containerViews.append(view.model)
-                else:
-                    self._m.containerViews = [view.model]
-            elif isinstance(view, ComponentView):
-                view._parent = self
-                view._on_added()
-                if self._m.componentViews:
-                    self._m.componentViews.append(view.model)
-                else:
-                    self._m.componentViews = [view.model]
-            else:
-                raise NotImplementedError("The view {0} is currently not supported", type(view))
-
-    def get_workspace(self) -> Workspace:
-        """
-        Get the `Workspace` which contain this views definition.
-        """
-        return self._parent
-
 class StyleElements:
 
     from buildzr.dsl.expression import Element

buildzr/dsl/explorer.py

@@ -14,12 +14,17 @@ from typing import (
     Union,
     Generator,
     Iterable,
+    cast,
 )
 
 from buildzr.dsl.dsl import (
     Workspace,
 )
 
+from buildzr.dsl.interfaces import (
+    DslRelationship,
+)
+
 class Explorer:
 
     def __init__(self, workspace_or_element: Union[Workspace, Person, SoftwareSystem, Container, Component]):
@@ -32,7 +37,7 @@ class Explorer:
                 yield child
                 yield from explorer
 
-    def walk_relationships(self) -> Generator[_Relationship, None, None]:
+    def walk_relationships(self) -> Generator[DslRelationship, None, None]:
 
         if self._workspace_or_element.children:
 
@@ -40,7 +45,7 @@ class Explorer:
 
                 if child.relationships:
                     for relationship in child.relationships:
-                        yield relationship
+                        yield cast(_Relationship, relationship) # TODO: Temporary fix. Use a better approach - Generics?
 
                 explorer = Explorer(child).walk_relationships()
                 yield from explorer

buildzr/dsl/expression.py

@@ -104,7 +104,7 @@ class Element:
 
 class Relationship:
 
-    def __init__(self, relationship: _Relationship):
+    def __init__(self, relationship: DslRelationship):
         self._relationship = relationship
 
     # TODO: Make a test for this in `tests/test_expression.py`

buildzr/dsl/interfaces/__init__.py

@@ -3,7 +3,6 @@ from .interfaces import (
     DslRelationship,
     DslWorkspaceElement,
     DslViewElement,
-    DslViewsElement,
     BindLeft,
     BindRight,
     BindLeftLate,

buildzr/dsl/interfaces/interfaces.py

@@ -205,31 +205,4 @@ class DslViewElement(ABC):
     @property
     @abstractmethod
     def model(self) -> ViewModel:
-        pass
-
-    @property
-    @abstractmethod
-    def parent(self) -> 'DslViewsElement':
-        pass
-
-    def _on_added(self) -> None:
-        pass
-
-class DslViewsElement(ABC):
-
-    @property
-    @abstractmethod
-    def model(self) -> buildzr.models.Views:
-        pass
-
-    @property
-    @abstractmethod
-    def parent(self) -> DslWorkspaceElement:
-        pass
-
-    @abstractmethod
-    def add_views(
-        self,
-        *views: Union[DslViewElement],
-    ) -> None:
         pass

{buildzr-0.0.11.dist-info → buildzr-0.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildzr
-Version: 0.0.11
+Version: 0.0.12
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues

{buildzr-0.0.11.dist-info → buildzr-0.0.12.dist-info}/RECORD

@@ -1,15 +1,15 @@
-buildzr/__about__.py,sha256=bj0hPvAeGyNerr-JDHit8pvb9_bqoEjX9AlWuS88Xhs,18
+buildzr/__about__.py,sha256=BCu0JmKIBuKGzB3jxd2V1AqofeA6ZLJuDN4qaEsLYbg,18
 buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
 buildzr/dsl/__init__.py,sha256=k0G9blhA3NSzCBs1dSfBNzCh0iDS_ylkzS_5a3pqrSY,375
 buildzr/dsl/color.py,sha256=at5lo3WgLEDCjrnbu37ra1p1TjzdB51sxeW7pBMC_7U,4019
-buildzr/dsl/dsl.py,sha256=47_O2OqN6XR7MNZnmJK2EaX8JPZrGu-h5YEVEaLUwdM,54154
-buildzr/dsl/explorer.py,sha256=vLAgQEYd0h22QuVfWfBdk4zyDpGaE1T67Pn9V7P1C-I,1238
-buildzr/dsl/expression.py,sha256=EMAtaZQA0O_zwENCZs3l4u_w9wUuO09XA0LgnvsomfA,8256
+buildzr/dsl/dsl.py,sha256=7OEz2JXm_1s7RN5G3wauwuBNly6odi19wPfpwC1FQI4,52601
+buildzr/dsl/explorer.py,sha256=GuQihoEvmTwiriXT3X8oasJ_U65ERyKJeJ2WW-S9D84,1389
+buildzr/dsl/expression.py,sha256=j847pBVQTvLbpxU1SB8ZYPbXO24SN-evprjAfkS6AGo,8258
 buildzr/dsl/relations.py,sha256=GBs5epr9uuExU_H6VcP4XY76iJPQ__rz_d8tZlhhWQ4,11891
 buildzr/dsl/factory/__init__.py,sha256=niaYqvNPUWJejoPyRyABUtzVsoxaV8eSjzS9dta4bMI,30
 buildzr/dsl/factory/gen_id.py,sha256=LnaeOCMngSvYkcGnuARjQYoUVWdcOoNHO2EHe6PMGco,538
-buildzr/dsl/interfaces/__init__.py,sha256=ncYARIPB4ARcCCRObgV1b4jluEubpm2s46mp1ZC8Urk,197
-buildzr/dsl/interfaces/interfaces.py,sha256=j8UCPCRegmFZ2Jl4qCz0uW0OxBS2mRe0VjPcNExH8mc,5553
+buildzr/dsl/interfaces/__init__.py,sha256=GRzfjdDxAUaZ-2n-eP4YaGLy3b0_giHhMshGqoj9rbo,176
+buildzr/dsl/interfaces/interfaces.py,sha256=OYOS-eGlkadGWXvcLSP1Qs9AnJfhtoJGh9UqJRC8gDk,5079
 buildzr/encoders/__init__.py,sha256=suID63Ay-023T0uKD25EAoGYmAMTa9AKxIjioccpiPM,32
 buildzr/encoders/encoder.py,sha256=n8WLVMrisykBTLTr1z6PAxgqhqW2dFRZhSupOuMdx_A,3235
 buildzr/models/__init__.py,sha256=SRfF7oDVlOOAi6nGKiJIUK6B_arqYLO9iSMp-2IZZps,21
@@ -18,7 +18,7 @@ buildzr/models/models.py,sha256=0LhLG1wmbt4dvROV5MEBZLLoxPbMpkUsOqNz525cynE,4248
 buildzr/sinks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buildzr/sinks/interfaces.py,sha256=LOZekP4WNjomD5J5f3FnZTwGj0aXMr6RbrvyFV5zn0E,383
 buildzr/sinks/json_sink.py,sha256=onKOZTpwOQfeMEj1ONkuIEHBAQhx4yQSqqI_lgZBaP8,777
-buildzr-0.0.11.dist-info/METADATA,sha256=y7VRNvZySrY7DsNV19V23WrYiOyx2VxLjcR_QkpSmSA,6579
-buildzr-0.0.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-buildzr-0.0.11.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
-buildzr-0.0.11.dist-info/RECORD,,
+buildzr-0.0.12.dist-info/METADATA,sha256=W2raGn9MDY9YAWC5wbwm8mwfwUbF8RQ2VXDaLsqLjPk,6579
+buildzr-0.0.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+buildzr-0.0.12.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.12.dist-info/RECORD,,