buildzr 0.0.15__py3-none-any.whl → 0.0.17__py3-none-any.whl

buildzr/__about__.py

@@ -1 +1 @@
-VERSION = "0.0.15"
+VERSION = "0.0.17"

buildzr/dsl/dsl.py

@@ -133,12 +133,21 @@ class Workspace(DslWorkspaceElement):
         self,
     ) -> None:
 
+        """
+        Process implied relationships:
+        If we have relationship s >> do >> a.b, then create s >> do >> a.
+        If we have relationship s.ss >> do >> a.b.c, then create s.ss >> do >> a.b and s.ss >> do >> a.
+        And so on...
+
+        This process is idempotent, which means this can be called multiple times
+        without duplicating similar relationships.
+        """
+
+        if not self._use_implied_relationships:
+            return
+
         from buildzr.dsl.explorer import Explorer
 
-        # Process implied relationships:
-        # If we have relationship s >> do >> a.b, then create s >> do >> a.
-        # If we have relationship s.ss >> do >> a.b.c, then create s.ss >> do >> a.b and s.ss >> do >> a.
-        # And so on...
         explorer = Explorer(self)
         relationships = list(explorer.walk_relationships())
         for relationship in relationships:
@@ -201,8 +210,7 @@ class Workspace(DslWorkspaceElement):
         else:
             raise ValueError('Invalid element type: Trying to add an element of type {} to a workspace.'.format(type(model)))
 
-    def apply_view(
-        self,
+    def apply_view( self,
         view: Union[
             'SystemLandscapeView',
             'SystemContextView',
@@ -212,6 +220,8 @@ class Workspace(DslWorkspaceElement):
         ]
     ) -> None:
 
+        self._imply_relationships()
+
         view._on_added(self)
 
         if not self.model.views:
@@ -269,10 +279,14 @@ class Workspace(DslWorkspaceElement):
             else:
                 self.model.views.configuration.styles.relationships = style.model
 
-    def to_json(self, path: str) -> None:
+    def to_json(self, path: str, pretty: bool=False) -> None:
+
+        self._imply_relationships()
+
         from buildzr.sinks.json_sink import JsonSink, JsonSinkConfig
         sink = JsonSink()
-        sink.write(workspace=self.model, config=JsonSinkConfig(path=path))
+        sink.write(workspace=self.model, config=JsonSinkConfig(path=path, pretty=pretty))
+
 
     def _add_dynamic_attr(self, name: str, model: Union['Person', 'SoftwareSystem']) -> None:
         if isinstance(model, Person):

buildzr/sinks/json_sink.py

@@ -9,13 +9,15 @@ from buildzr.sinks.interfaces import Sink
 @dataclass
 class JsonSinkConfig:
     path: str
+    pretty: bool = False
 
 class JsonSink(Sink[JsonSinkConfig]):
 
     def write(self, workspace: Workspace, config: Optional[JsonSinkConfig]=None) -> None:
         if config is not None:
+            indent = 2 if config.pretty else None
             with open(config.path, 'w') as file:
-                file.write(JsonEncoder().encode(workspace))
+                file.write(JsonEncoder(indent=indent).encode(workspace))
         else:
             import os
             workspace_name = workspace.name.replace(' ', '_').lower()

{buildzr-0.0.15.dist-info → buildzr-0.0.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildzr
-Version: 0.0.15
+Version: 0.0.17
 Summary: Structurizr for the `buildzr`s 🧱⚒️
 Project-URL: homepage, https://github.com/amirulmenjeni/buildzr
 Project-URL: issues, https://github.com/amirulmenjeni/buildzr/issues
@@ -34,6 +34,9 @@ If you're not familiar with Structurizr, it is both an open standard (see [Struc
 
 In Structurizr, you define architecture models and their relationships first. And then, you can re-use the models to present multiple perspectives, views, and stories about your architecture.
 
+Head over to [ROADMAP.md](./ROADMAP.md) to get a good high-level sense of what has been implemented in `buildzr`.
+
+
 # Quick Start 🚀
 
 ## Installation

{buildzr-0.0.15.dist-info → buildzr-0.0.17.dist-info}/RECORD

@@ -1,8 +1,8 @@
-buildzr/__about__.py,sha256=xK6ASlZ-LGNxCgeQYxBRdP_iYzoDtr4OE7DU9k86Kuo,19
+buildzr/__about__.py,sha256=FuXai4m-tgRgZ8KBZ-0FvcOhuA5UBAazPvu_4YgO1kY,19
 buildzr/__init__.py,sha256=hY-cOdjBQcz0v2m8cBF1oEJFIbcR3sWI-xww--0RKSo,99
 buildzr/dsl/__init__.py,sha256=qJ41IXcabKUjvwMzgfUCFdmDnSBBK7VFADpoVdOYLKQ,538
 buildzr/dsl/color.py,sha256=at5lo3WgLEDCjrnbu37ra1p1TjzdB51sxeW7pBMC_7U,4019
-buildzr/dsl/dsl.py,sha256=qqKlz8KNzAxdwsdPM5YhVE2JhwYMRJ9o7KbMMarQGlw,83579
+buildzr/dsl/dsl.py,sha256=l3eM3WtcBMcoroXgn2gKaMluFb4rQUrFSRx89kuGshc,83901
 buildzr/dsl/explorer.py,sha256=m1nI0Rd0bXGj1uXDgTC4DJhc2FMma522IepPNvQF07E,1853
 buildzr/dsl/expression.py,sha256=TLSe-uGlHhNqMPQU_5IRLIP-ZGsQ_ts3DquBMcYlwBg,11777
 buildzr/dsl/relations.py,sha256=GBs5epr9uuExU_H6VcP4XY76iJPQ__rz_d8tZlhhWQ4,11891
@@ -17,8 +17,8 @@ buildzr/models/generate.sh,sha256=EJ63d4cYmRnMFzc3hIR6bro44PXYEOt3EE9BxY4F8cU,16
 buildzr/models/models.py,sha256=NJOFYiRQ2i_1gP2ajPNpEfVLAz-1iCqqt1gPOHDPIks,42587
 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.15.dist-info/METADATA,sha256=YS8BlFjIX0Pbbe-gLGjxvfWMrCw1N7c4crgpgaalKF8,6480
-buildzr-0.0.15.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-buildzr-0.0.15.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
-buildzr-0.0.15.dist-info/RECORD,,
+buildzr/sinks/json_sink.py,sha256=w_16ulQl2s-J-Yokp6GvDhAhuqN8XggXyEHCUNETLu4,865
+buildzr-0.0.17.dist-info/METADATA,sha256=hHN9k8oQtuVu0hKASmJpvvoXl7GP1ZbfDdquEWbWlcU,6596
+buildzr-0.0.17.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+buildzr-0.0.17.dist-info/licenses/LICENSE.md,sha256=e8e6W6tL4MbBY-c-gXMgDbaMf_BnaQDQv4Yoy42b-CI,1070
+buildzr-0.0.17.dist-info/RECORD,,