buildzr 0.0.5__py3-none-any.whl → 0.0.7__py3-none-any.whl

buildzr/__about__.py

@@ -1 +1 @@
-VERSION = "0.0.5"
+VERSION = "0.0.7"

buildzr/dsl/dsl.py

@@ -26,10 +26,14 @@ from typing import (
     Type,
 )
 
+from buildzr.sinks.interfaces import Sink
+
 from buildzr.dsl.interfaces import (
     DslWorkspaceElement,
     DslElement,
+    DslViewElement,
     DslViewsElement,
+    DslFluentSink,
     TSrc, TDst,
     TParent, TChild,
 )
@@ -45,20 +49,6 @@ from buildzr.dsl.relations import (
 def _child_name_transform(name: str) -> str:
     return name.lower().replace(' ', '_')
 
-# TODO: Remove, not used.
-# def _create_linked_relationship_from(
-#     relationship: '_Relationship[TSrc, TDst]') -> buildzr.models.Relationship:
-
-#     src = relationship.source
-#     dst = relationship.destination
-
-#     return buildzr.models.Relationship(
-#         id=GenerateId.for_relationship(),
-#         sourceId=str(src.model.id),
-#         destinationId=str(dst.parent.model.id),
-#         linkedRelationshipId=relationship.model.id,
-#     )
-
 TypedModel = TypeVar('TypedModel')
 class TypedDynamicAttribute(Generic[TypedModel]):
 
@@ -197,7 +187,7 @@ class Workspace(DslWorkspaceElement):
             'ContainerView',
             'ComponentView',
         ]
-    ) -> 'Views':
+    ) -> '_FluentSink':
         return Views(self).contains(*views)
 
     def __getattr__(self, name: str) -> Union['Person', 'SoftwareSystem']:
@@ -209,7 +199,15 @@ class Workspace(DslWorkspaceElement):
     def __dir__(self) -> Iterable[str]:
         return list(super().__dir__()) + list(self._dynamic_attrs.keys())
 
-class SoftwareSystem(DslElementRelationOverrides):
+class SoftwareSystem(DslElementRelationOverrides[
+    'SoftwareSystem',
+    Union[
+        'Person',
+        'SoftwareSystem',
+        'Container',
+        'Component'
+    ]
+]):
     """
     A software system.
     """
@@ -294,7 +292,15 @@ class SoftwareSystem(DslElementRelationOverrides):
     def __dir__(self) -> Iterable[str]:
         return list(super().__dir__()) + list(self._dynamic_attrs.keys())
 
-class Person(DslElementRelationOverrides):
+class Person(DslElementRelationOverrides[
+    'Person',
+    Union[
+        'Person',
+        'SoftwareSystem',
+        'Container',
+        'Component'
+    ]
+]):
     """
     A person who uses a software system.
     """
@@ -345,7 +351,15 @@ class Person(DslElementRelationOverrides):
         self._label = label
         return self
 
-class Container(DslElementRelationOverrides):
+class Container(DslElementRelationOverrides[
+    'Container',
+    Union[
+        'Person',
+        'SoftwareSystem',
+        'Container',
+        'Component'
+    ]
+]):
     """
     A container (something that can execute code or host data).
     """
@@ -425,7 +439,15 @@ class Container(DslElementRelationOverrides):
     def __dir__(self) -> Iterable[str]:
         return list(super().__dir__()) + list(self._dynamic_attrs.keys())
 
-class Component(DslElementRelationOverrides):
+class Component(DslElementRelationOverrides[
+    'Component',
+    Union[
+        'Person',
+        'SoftwareSystem',
+        'Container',
+        'Component'
+    ]
+]):
     """
     A component (a grouping of related functionality behind an interface that runs inside a container).
     """
@@ -487,6 +509,19 @@ class Group:
         self._name = name
         self._elements = elements
 
+class _FluentSink(DslFluentSink):
+
+    def __init__(self, workspace: Workspace) -> None:
+        self._workspace = workspace
+
+    def to_json(self, path: str) -> None:
+        from buildzr.sinks.json_sink import JsonSink, JsonSinkConfig
+        sink = JsonSink()
+        sink.write(workspace=self._workspace.model, config=JsonSinkConfig(path=path))
+
+    def get_workspace(self) -> Workspace:
+        return self._workspace
+
 _RankDirection = Literal['tb', 'bt', 'lr', 'rl']
 
 _AutoLayout = Optional[
@@ -554,7 +589,7 @@ def _auto_layout_to_model(auto_layout: _AutoLayout) -> buildzr.models.AutomaticL
 
     return model
 
-class SystemLandscapeView:
+class SystemLandscapeView(DslViewElement):
 
     from buildzr.dsl.expression import Expression, Element, Relationship
 
@@ -649,7 +684,7 @@ class SystemLandscapeView:
         for relationship_id in relationship_ids:
             self._m.relationships.append(RelationshipView(id=relationship_id))
 
-class SystemContextView:
+class SystemContextView(DslViewElement):
 
     """
     If no filter is applied, this view includes all elements that have a direct
@@ -700,9 +735,6 @@ class SystemContextView:
         from buildzr.dsl.expression import Expression, Element, Relationship
         from buildzr.models import ElementView, RelationshipView
 
-        # TODO: Refactor below codes. Similar patterns may exists for other views.
-        # Maybe make the views a subclass of some abstract `BaseView` class?
-
         software_system = self._selector(self._parent._parent)
         self._m.softwareSystemId = software_system.model.id
         view_elements_filter: List[Callable[[Workspace, Element], bool]] = [
@@ -711,10 +743,6 @@ class SystemContextView:
             lambda w, e: software_system.model.id in e.destinations.ids,
         ]
 
-        # TODO: (Or, TOTHINK?) The code below includes all sources and all
-        # destinations of the subject software system. What if we want to
-        # exclude a source? Maybe the predicates in `elements` and
-        # `relationships` should be ANDed together afterall?
         view_relationships_filter: List[Callable[[Workspace, Relationship], bool]] = [
             lambda w, r: software_system == r.source,
             lambda w, r: software_system == r.destination,
@@ -747,7 +775,7 @@ class SystemContextView:
         for relationship_id in relationship_ids:
             self._m.relationships.append(RelationshipView(id=relationship_id))
 
-class ContainerView:
+class ContainerView(DslViewElement):
 
     from buildzr.dsl.expression import Expression, Element, Relationship
 
@@ -836,7 +864,7 @@ class ContainerView:
         for relationship_id in relationship_ids:
             self._m.relationships.append(RelationshipView(id=relationship_id))
 
-class ComponentView:
+class ComponentView(DslViewElement):
 
     from buildzr.dsl.expression import Expression, Element, Relationship
 
@@ -945,34 +973,33 @@ class Views(DslViewsElement):
 
     def contains(
         self,
-        *views: Union[
-            SystemLandscapeView,
-            SystemContextView,
-            ContainerView,
-            ComponentView,
-        ]) -> Self:
+        *views: DslViewElement
+    ) -> _FluentSink:
 
         for view in views:
-            view._parent = self
             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)
@@ -981,7 +1008,7 @@ class Views(DslViewsElement):
             else:
                 raise NotImplementedError("The view {0} is currently not supported", type(view))
 
-        return self
+        return _FluentSink(self._parent)
 
     def get_workspace(self) -> Workspace:
         """

buildzr/dsl/interfaces/__init__.py

@@ -1,8 +1,10 @@
 from .interfaces import (
     DslElement,
     DslFluentRelationship,
+    DslFluentSink,
     DslRelationship,
     DslWorkspaceElement,
+    DslViewElement,
     DslViewsElement,
     BindLeft,
     BindRight,

buildzr/dsl/interfaces/interfaces.py

@@ -199,6 +199,36 @@ class DslFluentRelationship(ABC, Generic[TParent]):
     def get(self) -> TParent:
         pass
 
+class DslFluentSink(ABC):
+
+    @abstractmethod
+    def to_json(self, path: str) -> None:
+        pass
+
+class DslViewElement(ABC):
+
+    ViewModel = Union[
+        buildzr.models.SystemLandscapeView,
+        buildzr.models.SystemContextView,
+        buildzr.models.ContainerView,
+        buildzr.models.ComponentView,
+        buildzr.models.DynamicView,
+        buildzr.models.DeploymentView,
+    ]
+
+    @property
+    @abstractmethod
+    def model(self) -> ViewModel:
+        pass
+
+    @property
+    @abstractmethod
+    def parent(self) -> 'DslViewsElement':
+        pass
+
+    def _on_added(self) -> None:
+        pass
+
 class DslViewsElement(ABC):
 
     @property
@@ -209,4 +239,11 @@ class DslViewsElement(ABC):
     @property
     @abstractmethod
     def parent(self) -> DslWorkspaceElement:
+        pass
+
+    @abstractmethod
+    def contains(
+        self,
+        *views: Union[DslViewElement],
+    ) -> DslFluentSink:
         pass

buildzr/dsl/relations.py

@@ -204,6 +204,8 @@ class _FluentRelationship(DslFluentRelationship[TParent]):
 
         return self._parent
 
+    # TODO: Remove this and replace with something better.
+    # Doesn't feel "fluent."
     def get(self) -> TParent:
         return self._parent
 
@@ -224,7 +226,7 @@ class _RelationshipDescription(Generic[TDst]):
             destination=destination,
         )
 
-class _UsesFromLate(BindLeftLate[TDst]):
+class _UsesFromLate(Generic[TDst], BindLeftLate[TDst]):
     """
     This method is used to create a relationship between one source element with
     multiple destination elements, like so:
@@ -306,7 +308,7 @@ class _UsesFromLate(BindLeftLate[TDst]):
 
         return self
 
-class DslElementRelationOverrides(DslElement):
+class DslElementRelationOverrides(Generic[TSrc, TDst], DslElement[TSrc, TDst]):
 
     """
     Base class meant to be derived from to override the `__rshift__` method to
@@ -316,7 +318,7 @@ class DslElementRelationOverrides(DslElement):
 
     # TODO: Check why need to ignore the override error here.
     @overload  # type: ignore[override]
-    def __rshift__(self, other: DslElement) -> _Relationship[Self, DslElement]:
+    def __rshift__(self, other: TDst) -> _Relationship[Self, TDst]:
         """
         Create a relationship between the source element and the destination
         without specifying description or technology.
@@ -326,30 +328,30 @@ class DslElementRelationOverrides(DslElement):
         ...
 
     @overload
-    def __rshift__(self, description_and_technology: Tuple[str, str]) -> _UsesFrom[Self, DslElement]:
+    def __rshift__(self, description_and_technology: Tuple[str, str]) -> _UsesFrom[Self, TDst]:
         ...
 
     @overload
-    def __rshift__(self, description: str) -> _UsesFrom[Self, DslElement]:
+    def __rshift__(self, description: str) -> _UsesFrom[Self, TDst]:
         ...
 
     @overload
-    def __rshift__(self, _RelationshipDescription: _RelationshipDescription[DslElement]) -> _UsesFrom[Self, DslElement]:
+    def __rshift__(self, _RelationshipDescription: _RelationshipDescription[TDst]) -> _UsesFrom[Self, TDst]:
         ...
 
     @overload
-    def __rshift__(self, multiple_destinations: List[Union[DslElement, _UsesFromLate[DslElement]]]) -> List[_Relationship[Self, DslElement]]:
+    def __rshift__(self, multiple_destinations: List[Union[TDst, _UsesFromLate[TDst]]]) -> List[_Relationship[Self, TDst]]:
         ...
 
     def __rshift__(
             self,
             other: Union[
-                DslElement,
+                TDst,
                 str,
                 Tuple[str, str],
-                _RelationshipDescription[DslElement],
-                List[Union[DslElement, _UsesFromLate[DslElement]]]
-            ]) -> Union[_UsesFrom[Self, DslElement], _Relationship[Self, DslElement], List[_Relationship[Self, DslElement]]]:
+                _RelationshipDescription[TDst],
+                List[Union[TDst, _UsesFromLate[TDst]]]
+            ]) -> Union[_UsesFrom[Self, TDst], _Relationship[Self, TDst], List[_Relationship[Self, TDst]]]:
         if isinstance(other, DslElement):
             return cast(
                 _Relationship[Self, DslElement],
@@ -364,8 +366,8 @@ class DslElementRelationOverrides(DslElement):
             return _UsesFrom(self, description=other[0], technology=other[1])
         elif isinstance(other, _RelationshipDescription):
             return _UsesFrom(self, description=other._description, technology=other._technology)
-        elif _is_list_of_dslelements_or_usesfromlates(other):
-            relationships: List[_Relationship[Self, DslElement]] = []
+        elif isinstance(other, list):
+            relationships: List[_Relationship[Self, TDst]] = []
             for dest in other:
                 if isinstance(dest, _UsesFromLate):
                     dest.set_source(self)
@@ -373,14 +375,21 @@ class DslElementRelationOverrides(DslElement):
                 elif isinstance(dest, DslElement):
                     relationships.append(
                         cast(
-                            _Relationship[Self, DslElement],
+                            _Relationship[Self, DslElement[Self, TDst]],
                             cast(
-                                _UsesFrom[Self, DslElement],
+                                _UsesFrom[Self, DslElement[Self, TDst]],
                                 _UsesFrom(self)
                             ) >> dest
                         )
                     )
-            return relationships
+            return cast(
+                Union[
+                    List[_Relationship[Self, TDst]],
+                    _UsesFrom[Self, TDst],
+                    _Relationship[Self, TDst],
+                ],
+                relationships
+            )
         else:
             raise TypeError(f"Unsupported operand type for >>: '{type(self).__name__}' and {type(other).__name__}")
 

buildzr/sinks/interfaces.py

@@ -0,0 +1,18 @@
+from typing import (
+    Optional,
+    Any,
+    TypedDict,
+    TypeVar,
+    Generic,
+)
+from dataclasses import dataclass
+from abc import ABC, abstractmethod
+from buildzr.models.models import Workspace
+
+TConfig = TypeVar('TConfig')
+
+class Sink(ABC, Generic[TConfig]):
+
+    @abstractmethod
+    def write(self, workspace: Workspace, config: Optional[TConfig]=None) -> None:
+        pass

buildzr/sinks/json_sink.py

@@ -0,0 +1,24 @@
+from typing import (
+    Optional,
+)
+from dataclasses import dataclass
+from buildzr.models.models import Workspace
+from buildzr.encoders.encoder import JsonEncoder
+from buildzr.sinks.interfaces import Sink
+
+@dataclass
+class JsonSinkConfig:
+    path: str
+
+class JsonSink(Sink[JsonSinkConfig]):
+
+    def write(self, workspace: Workspace, config: Optional[JsonSinkConfig]=None) -> None:
+        if config is not None:
+            with open(config.path, 'w') as file:
+                file.write(JsonEncoder().encode(workspace))
+        else:
+            import os
+            workspace_name = workspace.name.replace(' ', '_').lower()
+
+            with open(os.path.join(os.curdir, f'{workspace_name}.json'), 'w') as file:
+                file.write(JsonEncoder().encode(workspace))

{buildzr-0.0.5.dist-info → buildzr-0.0.7.dist-info}/METADATA

@@ -1,11 +1,10 @@
 Metadata-Version: 2.3
 Name: buildzr
-Version: 0.0.5
+Version: 0.0.7
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
 Author-email: Amirul Menjeni <amirulmenjeni@pm.me>
-License-File: LICENSE.md
 Keywords: architecture,buildzr,c4model,design,diagram,structurizr
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: MIT License
@@ -118,15 +117,15 @@ w = Workspace('w')\
     )\
     .get_workspace()
 
-# Writes the Workspace model to a JSON file.
-with open(os.path.join(os.path.curdir, f"{__file__.split('.')[0]}.json"), 'w', encoding='utf-8') as f:
-    json.dump(w.model, f, ensure_ascii=False, indent=4, cls=JsonEncoder)
+# Save workspace to a JSON file following the Structurizr JSON schema.
+w.to_json('workspace.json')
 ```
 
 Here's a short breakdown on what's happening:
 - In `Workspace(...).contains(...)` method, we define the _static_ C4 models (i.e., `Person`, `SoftwareSystem`, and the `Container`s in the software system).
 - In the `Workspace(...).contains(...).where(...)`, we define the relationships between the C4 models in the workspace. We access the models via the `w` parameter in the `lambda` function, and create the relationships using the `>>` operators.
-- Finally, once we have all the models and their relationships defined, we use (and re-use!) the static models to create multiple views to tell different stories and show various narrative to help document your software architecture.
+- Once we have all the models and their relationships defined, we use (and re-use!) the static models to create multiple views to tell different stories and show various narrative to help document your software architecture.
+- Finally, we write the workspace definitions into a JSON file, which can be consumed by rendering tools, or used for further processing.
 
 The JSON output can be found [here](examples/system_context_and_container_view.json). You can also try out https://structurizr.com/json to see how this workspace will be rendered.
 

{buildzr-0.0.5.dist-info → buildzr-0.0.7.dist-info}/RECORD

@@ -1,20 +1,23 @@
-buildzr/__about__.py,sha256=GeH0UroAT_T3yxBAz5ZecPeQPBuC9n6qCz2aZiSCOME,17
+buildzr/__about__.py,sha256=mxN_6Jqd8AWInKb6pHwebAtbTNsZmgF0Jj4L8NNGU5I,17
 buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
 buildzr/dsl/__init__.py,sha256=paxuMCCDuOs1eSvBPyuW5pv5j1UZD6TxRZcCzC2iKss,307
-buildzr/dsl/dsl.py,sha256=X5lJJhD9dQ7YlRAECdXJb9qJKWfrfi-1H5rESYOnGhI,34584
+buildzr/dsl/dsl.py,sha256=7KUe_YLSjOKG5D5MDJkJddt2evYM_Q1JeSkBMsu-83w,34782
 buildzr/dsl/explorer.py,sha256=numMPqD3RYJ1oeMgX5wYnT6aHRHmBN2EsFZFYRuFffA,2523
 buildzr/dsl/expression.py,sha256=UinOUL3nJytZR8ylnVtVkJ0YoWoWspU9DQeDpg0nIEQ,6927
-buildzr/dsl/relations.py,sha256=nfj0EZIo0RpQxe7Ng-40WHBOVom_aE20-45GzWMEvII,13723
+buildzr/dsl/relations.py,sha256=SajN7beDhPFYnJ-4RXgJ4YGY5g-7Uw9n8IDlysGMmNg,13978
 buildzr/dsl/factory/__init__.py,sha256=niaYqvNPUWJejoPyRyABUtzVsoxaV8eSjzS9dta4bMI,30
 buildzr/dsl/factory/gen_id.py,sha256=LnaeOCMngSvYkcGnuARjQYoUVWdcOoNHO2EHe6PMGco,538
-buildzr/dsl/interfaces/__init__.py,sha256=T0Az1IDLsTUYHoaGBStbS5V-acaJAlFUpDo-6Q0MrOY,229
-buildzr/dsl/interfaces/interfaces.py,sha256=aQQEttOF4cYCBR9axLIFu8PD4NqWB-Izdchpf8X4AkQ,5138
+buildzr/dsl/interfaces/__init__.py,sha256=z8d8HzL64m8aT_HHM3mCVZoNwh_QhsYv0apGz-EX9Us,268
+buildzr/dsl/interfaces/interfaces.py,sha256=UfysJ1X0RQiPAEl_kBlcoxuWEO-kmg3c3gveN6klUG8,5885
 buildzr/encoders/__init__.py,sha256=suID63Ay-023T0uKD25EAoGYmAMTa9AKxIjioccpiPM,32
 buildzr/encoders/encoder.py,sha256=9_FlQ3aYvz0EcN_G9A3bPdqxCTkLhc2OrYXSYti95f8,2237
 buildzr/models/__init__.py,sha256=SRfF7oDVlOOAi6nGKiJIUK6B_arqYLO9iSMp-2IZZps,21
 buildzr/models/generate.sh,sha256=924UoEXr5WBZ926TZfRgEQGHwBqtLGU5k0G2UfExLEg,1061
 buildzr/models/models.py,sha256=0LhLG1wmbt4dvROV5MEBZLLoxPbMpkUsOqNz525cynE,42489
-buildzr-0.0.5.dist-info/METADATA,sha256=X-BobTvZjQ5Q7ldnDjpFiLpZrlxdM9_bJeEz4bRAMo0,6255
-buildzr-0.0.5.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-buildzr-0.0.5.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
-buildzr-0.0.5.dist-info/RECORD,,
+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.7.dist-info/METADATA,sha256=eVaFO4ZV4LROB8GVPIYxjSqeuXZw3RVNP0eSOnOKoTA,6237
+buildzr-0.0.7.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+buildzr-0.0.7.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.7.dist-info/RECORD,,

{buildzr-0.0.5.dist-info → buildzr-0.0.7.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any