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

buildzr/__about__.py

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

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()
@@ -738,30 +767,25 @@ def _auto_layout_to_model(auto_layout: _AutoLayout) -> buildzr.models.AutomaticL
 
 class SystemLandscapeView(DslViewElement):
 
-    from buildzr.dsl.expression import Expression, Element, Relationship
+    from buildzr.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
 
     @property
     def model(self) -> buildzr.models.SystemLandscapeView:
         return self._m
 
-    @property
-    def parent(self) -> Optional['Views']:
-        return self._parent
-
     def __init__(
         self,
         key: str,
         description: str,
         auto_layout: _AutoLayout='tb',
         title: Optional[str]=None,
-        include_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        exclude_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
-        exclude_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        exclude_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
+        exclude_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
         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,11 +801,11 @@ 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.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
         from buildzr.models import ElementView, RelationshipView
 
         expression = Expression(
@@ -791,19 +815,17 @@ class SystemLandscapeView(DslViewElement):
             exclude_relationships=self._exclude_relationships,
         )
 
-        workspace = self._parent._parent
-
-        include_view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
+        include_view_elements_filter: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]] = [
             lambda w, e: e.type == Person,
             lambda w, e: e.type == SoftwareSystem
         ]
 
-        exclude_view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
+        exclude_view_elements_filter: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]] = [
             lambda w, e: e.type == Container,
             lambda w, e: e.type == Component,
         ]
 
-        include_view_relationships_filter: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]] = [
+        include_view_relationships_filter: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]] = [
             lambda w, r: r.source.type == Person,
             lambda w, r: r.source.type == SoftwareSystem,
             lambda w, r: r.destination.type == Person,
@@ -842,31 +864,26 @@ class SystemContextView(DslViewElement):
     relationship with the selected `SoftwareSystem`.
     """
 
-    from buildzr.dsl.expression import Expression, Element, Relationship
+    from buildzr.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
 
     @property
     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]],
+        software_system_selector: Union[SoftwareSystem, Callable[[WorkspaceExpression], SoftwareSystem]],
         key: str,
         description: str,
         auto_layout: _AutoLayout='tb',
         title: Optional[str]=None,
-        include_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        exclude_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
-        exclude_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        exclude_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
+        exclude_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
         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,25 +900,25 @@ 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.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
         from buildzr.models import ElementView, RelationshipView
 
         if isinstance(self._selector, SoftwareSystem):
             software_system = self._selector
         else:
-            software_system = self._selector(self._parent._parent)
+            software_system = self._selector(WorkspaceExpression(workspace))
         self._m.softwareSystemId = software_system.model.id
-        view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
+        view_elements_filter: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]] = [
             lambda w, e: e == software_system,
             lambda w, e: software_system.model.id in e.sources.ids,
             lambda w, e: software_system.model.id in e.destinations.ids,
         ]
 
-        view_relationships_filter: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]] = [
+        view_relationships_filter: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]] = [
             lambda w, r: software_system == r.source,
             lambda w, r: software_system == r.destination,
         ]
@@ -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)
@@ -935,31 +950,26 @@ class SystemContextView(DslViewElement):
 
 class ContainerView(DslViewElement):
 
-    from buildzr.dsl.expression import Expression, Element, Relationship
+    from buildzr.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
 
     @property
     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]],
+        software_system_selector: Union[SoftwareSystem, Callable[[WorkspaceExpression], SoftwareSystem]],
         key: str,
         description: str,
         auto_layout: _AutoLayout='tb',
         title: Optional[str]=None,
-        include_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        exclude_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
-        exclude_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        exclude_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
+        exclude_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
         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,28 +986,28 @@ 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.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
         from buildzr.models import ElementView, RelationshipView
 
         if isinstance(self._selector, SoftwareSystem):
             software_system = self._selector
         else:
-            software_system = self._selector(self._parent._parent)
+            software_system = self._selector(WorkspaceExpression(workspace))
         self._m.softwareSystemId = software_system.model.id
 
         container_ids = { container.model.id for container in software_system.children}
 
-        view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
+        view_elements_filter: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]] = [
             lambda w, e: e.parent == software_system,
             lambda w, e: any(container_ids.intersection({ id for id in e.sources.ids })),
             lambda w, e: any(container_ids.intersection({ id for id in e.destinations.ids })),
         ]
 
-        view_relationships_filter: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]] = [
+        view_relationships_filter: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]] = [
             lambda w, r: software_system == r.source.parent,
             lambda w, r: software_system == r.destination.parent,
         ]
@@ -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)
@@ -1031,31 +1039,26 @@ class ContainerView(DslViewElement):
 
 class ComponentView(DslViewElement):
 
-    from buildzr.dsl.expression import Expression, Element, Relationship
+    from buildzr.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
 
     @property
     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]],
+        container_selector: Union[Container, Callable[[WorkspaceExpression], Container]],
         key: str,
         description: str,
         auto_layout: _AutoLayout='tb',
         title: Optional[str]=None,
-        include_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        exclude_elements: List[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
-        exclude_relationships: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        exclude_elements: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
+        exclude_relationships: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
         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,28 +1075,28 @@ 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.dsl.expression import Expression, WorkspaceExpression, ElementExpression, RelationshipExpression
         from buildzr.models import ElementView, RelationshipView
 
         if isinstance(self._selector, Container):
             container = self._selector
         else:
-            container = self._selector(self._parent._parent)
+            container = self._selector(WorkspaceExpression(workspace))
         self._m.containerId = container.model.id
 
         component_ids = { component.model.id for component in container.children }
 
-        view_elements_filter: List[Union[DslElement, Callable[[Workspace, Element], bool]]] = [
+        view_elements_filter: List[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]] = [
             lambda w, e: e.parent == container,
             lambda w, e: any(component_ids.intersection({ id for id in e.sources.ids })),
             lambda w, e: any(component_ids.intersection({ id for id in e.destinations.ids })),
         ]
 
-        view_relationships_filter: List[Union[DslElement, Callable[[Workspace, Relationship], bool]]] = [
+        view_relationships_filter: List[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]] = [
             lambda w, r: container == r.source.parent,
             lambda w, r: container == r.destination.parent,
         ]
@@ -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,73 +1126,9 @@ 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
+    from buildzr.dsl.expression import WorkspaceExpression, ElementExpression
 
     Shapes = Union[
         Literal['Box'],
@@ -1224,7 +1161,7 @@ class StyleElements:
             on: List[Union[
                 DslElement,
                 Group,
-                Callable[[Workspace, Element], bool],
+                Callable[[WorkspaceExpression, ElementExpression], bool],
                 Type[Union['Person', 'SoftwareSystem', 'Container', 'Component']],
                 str
             ]],
@@ -1267,7 +1204,7 @@ class StyleElements:
         # item, not for each of `StyleElements` instance. This makes the styling
         # makes more concise and flexible.
 
-        from buildzr.dsl.expression import Element
+        from buildzr.dsl.expression import ElementExpression
         from uuid import uuid4
 
         if background:
@@ -1340,7 +1277,7 @@ class StyleElements:
             elif isinstance(element, str):
                 element_style.tag = element
             elif callable(element):
-                from buildzr.dsl.expression import Element, Expression
+                from buildzr.dsl.expression import ElementExpression, Expression
                 if self._parent:
                     matched_elems = Expression(include_elements=[element]).elements(self._parent)
                     for e in matched_elems:
@@ -1356,7 +1293,7 @@ class StyleElements:
 
 class StyleRelationships:
 
-    from buildzr.dsl.expression import Relationship
+    from buildzr.dsl.expression import WorkspaceExpression, RelationshipExpression
 
     @property
     def model(self) -> List[buildzr.models.RelationshipStyle]:
@@ -1371,7 +1308,7 @@ class StyleRelationships:
         on: Optional[List[Union[
             DslRelationship,
             Group,
-            Callable[[Workspace, Relationship], bool],
+            Callable[[WorkspaceExpression, RelationshipExpression], bool],
             str
         ]]]=None,
         thickness: Optional[int]=None,

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

@@ -10,6 +10,7 @@ from buildzr.dsl.dsl import (
     SoftwareSystem,
     Container,
     Component,
+    TypedDynamicAttribute,
 )
 
 from buildzr.dsl.relations import _Relationship
@@ -47,12 +48,37 @@ class FlattenElement:
             all_tags = all_tags.union(tags)
         return all_tags
 
-class Element:
+class WorkspaceExpression:
+
+    """
+    A class used to filter the allowable methods and properties of the
+    `Structurizr DSL` workspace. This is used to filter the elements and
+    relationships in the workspace.
+    """
+
+    def __init__(self, workspace: Workspace):
+        self._workspace = workspace
+        self._dynamic_attributes = self._workspace._dynamic_attrs
+
+    def software_system(self) -> TypedDynamicAttribute['SoftwareSystem']:
+        """
+        Returns the software system of the workspace. This is used to filter the
+        elements and relationships in the workspace.
+        """
+        return TypedDynamicAttribute['SoftwareSystem'](self._dynamic_attributes)
+
+    def person(self) -> TypedDynamicAttribute['Person']:
+        """
+        Returns the person of the workspace. This is used to filter the elements
+        and relationships in the workspace.
+        """
+        return TypedDynamicAttribute['Person'](self._dynamic_attributes)
+
+class ElementExpression:
 
     def __init__(self, element: DslElement):
         self._element = element
 
-    # TODO: Make a test for this in `tests/test_expression.py`
     @property
     def id(self) -> str:
         return cast(str, self._element.model.id)
@@ -102,9 +128,9 @@ class Element:
         return isinstance(element, type(self._element)) and\
                element.model.id == self._element.model.id
 
-class Relationship:
+class RelationshipExpression:
 
-    def __init__(self, relationship: _Relationship):
+    def __init__(self, relationship: DslRelationship):
         self._relationship = relationship
 
     # TODO: Make a test for this in `tests/test_expression.py`
@@ -121,12 +147,12 @@ class Relationship:
         return self._relationship.model.technology
 
     @property
-    def source(self) -> Element:
-        return Element(self._relationship.source)
+    def source(self) -> ElementExpression:
+        return ElementExpression(self._relationship.source)
 
     @property
-    def destination(self) -> Element:
-        return Element(self._relationship.destination)
+    def destination(self) -> ElementExpression:
+        return ElementExpression(self._relationship.destination)
 
     @property
     def properties(self) -> Dict[str, Any]:
@@ -146,10 +172,10 @@ class Expression:
 
     def __init__(
         self,
-        include_elements: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]]=[lambda w, e: True],
-        exclude_elements: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]]=[],
-        include_relationships: Iterable[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[lambda w, e: True],
-        exclude_relationships: Iterable[Union[DslElement, Callable[[Workspace, Relationship], bool]]]=[],
+        include_elements: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[lambda w, e: True],
+        exclude_elements: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]]=[],
+        include_relationships: Iterable[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[lambda w, e: True],
+        exclude_relationships: Iterable[Union[DslElement, Callable[[WorkspaceExpression, RelationshipExpression], bool]]]=[],
     ) -> 'None':
         self._include_elements = include_elements
         self._exclude_elements = exclude_elements
@@ -171,12 +197,12 @@ class Expression:
                 if isinstance(f, DslElement):
                     includes.append(f == element)
                 else:
-                    includes.append(f(workspace, Element(element)))
+                    includes.append(f(WorkspaceExpression(workspace), ElementExpression(element)))
             for f in self._exclude_elements:
                 if isinstance(f, DslElement):
                     excludes.append(f == element)
                 else:
-                    excludes.append(f(workspace, Element(element)))
+                    excludes.append(f(WorkspaceExpression(workspace), ElementExpression(element)))
             if any(includes) and not any(excludes):
                 filtered_elements.append(element)
 
@@ -198,9 +224,9 @@ class Expression:
         filtered_relationships: List[DslRelationship] = []
 
         def _is_relationship_of_excluded_elements(
-            workspace: Workspace,
-            relationship: Relationship,
-            exclude_element_predicates: Iterable[Union[DslElement, Callable[[Workspace, Element], bool]]],
+            workspace: WorkspaceExpression,
+            relationship: RelationshipExpression,
+            exclude_element_predicates: Iterable[Union[DslElement, Callable[[WorkspaceExpression, ElementExpression], bool]]],
         ) -> bool:
             for f in exclude_element_predicates:
                 if isinstance(f, DslElement):
@@ -222,20 +248,20 @@ class Expression:
                 if isinstance(f, DslElement):
                     includes.append(f == relationship)
                 else:
-                    includes.append(f(workspace, Relationship(relationship)))
+                    includes.append(f(WorkspaceExpression(workspace), RelationshipExpression(relationship)))
 
             for f in self._exclude_relationships:
                 if isinstance(f, DslElement):
                     excludes.append(f == relationship)
                 else:
-                    excludes.append(f(workspace, Relationship(relationship)))
+                    excludes.append(f(WorkspaceExpression(workspace), RelationshipExpression(relationship)))
 
             # Also exclude relationships whose source or destination elements
             # are excluded.
             excludes.append(
                 _is_relationship_of_excluded_elements(
-                    workspace,
-                    Relationship(relationship),
+                    WorkspaceExpression(workspace),
+                    RelationshipExpression(relationship),
                     self._exclude_elements,
                 )
             )

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.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildzr
-Version: 0.0.11
+Version: 0.0.13
 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.13.dist-info}/RECORD

@@ -1,15 +1,15 @@
-buildzr/__about__.py,sha256=bj0hPvAeGyNerr-JDHit8pvb9_bqoEjX9AlWuS88Xhs,18
+buildzr/__about__.py,sha256=0umS7uDo4dgXIWRbDuyPpvLwiPObPtpkbuCwUnINda0,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=EXHGvC84Xz8ba2f3XMTS3HLqfrkxc8D905IThJu_WUM,53644
+buildzr/dsl/explorer.py,sha256=GuQihoEvmTwiriXT3X8oasJ_U65ERyKJeJ2WW-S9D84,1389
+buildzr/dsl/expression.py,sha256=Q4lK6tWETLg_YfLTGuT20Gl2dsWp6m5_8PhlTF_dJbw,9525
 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.13.dist-info/METADATA,sha256=oz1_tOasiJ4EKOqtPpO45Bq8jmoua3eoohE9mbK_CdQ,6579
+buildzr-0.0.13.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+buildzr-0.0.13.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.13.dist-info/RECORD,,