buildzr 0.0.3__tar.gz → 0.0.5__tar.gz

{buildzr-0.0.3 → buildzr-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: buildzr
-Version: 0.0.3
+Version: 0.0.5
 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.5/buildzr/__about__.py

@@ -0,0 +1 @@
+VERSION = "0.0.5"

{buildzr-0.0.3 → buildzr-0.0.5}/buildzr/dsl/interfaces/interfaces.py

@@ -52,6 +52,11 @@ class BindLeft(ABC, Generic[TSrc, TDst]):
 
 class BindRight(ABC, Generic[TSrc, TDst]):
 
+    @overload
+    @abstractmethod
+    def __rshift__(self, other: TDst) -> 'DslRelationship[TSrc, TDst]':
+        ...
+
     @overload
     @abstractmethod
     def __rshift__(self, description_and_technology: Tuple[str, str]) -> BindLeft[TSrc, TDst]:
@@ -64,11 +69,11 @@ class BindRight(ABC, Generic[TSrc, TDst]):
 
     @overload
     @abstractmethod
-    def __rshift__(self, multiple_destinations: List[BindLeftLate[TDst]]) -> 'List[DslRelationship[TSrc, TDst]]':
+    def __rshift__(self, multiple_destinations: List[Union[TDst, BindLeftLate[TDst]]]) -> 'List[DslRelationship[TSrc, TDst]]':
         ...
 
     @abstractmethod
-    def __rshift__(self, other: Union[str, Tuple[str, str], List[BindLeftLate[TDst]]]) -> Union[BindLeft[TSrc, TDst], 'List[DslRelationship[TSrc, TDst]]']:
+    def __rshift__(self, other: Union[TDst, str, Tuple[str, str], List[Union[TDst, BindLeftLate[TDst]]]]) -> Union[BindLeft[TSrc, TDst], 'DslRelationship[TSrc, TDst]', 'List[DslRelationship[TSrc, TDst]]']:
         ...
 
 class DslWorkspaceElement(ABC):
@@ -204,4 +209,4 @@ class DslViewsElement(ABC):
     @property
     @abstractmethod
     def parent(self) -> DslWorkspaceElement:
-        pass
+        pass

{buildzr-0.0.3 → buildzr-0.0.5}/buildzr/dsl/relations.py

@@ -37,6 +37,14 @@ def _is_container_fluent_relationship(
 ) -> TypeIs['_FluentRelationship[buildzr.dsl.Container]']:
     return isinstance(obj._parent, buildzr.dsl.Container)
 
+def _is_list_of_dslelements_or_usesfromlates(
+    obj: list
+) -> TypeIs[List[Union[DslElement, '_UsesFromLate[DslElement]']]]:
+    return all(
+        isinstance(item, DslElement) or isinstance(item, _UsesFromLate)
+        for item in obj
+    )
+
 @dataclass
 class With:
     tags: Optional[Set[str]] = None
@@ -306,7 +314,18 @@ class DslElementRelationOverrides(DslElement):
     elements.
     """
 
-    @overload # type: ignore[override]
+    # TODO: Check why need to ignore the override error here.
+    @overload  # type: ignore[override]
+    def __rshift__(self, other: DslElement) -> _Relationship[Self, DslElement]:
+        """
+        Create a relationship between the source element and the destination
+        without specifying description or technology.
+
+        Example: `source >> destination`.
+        """
+        ...
+
+    @overload
     def __rshift__(self, description_and_technology: Tuple[str, str]) -> _UsesFrom[Self, DslElement]:
         ...
 
@@ -319,29 +338,49 @@ class DslElementRelationOverrides(DslElement):
         ...
 
     @overload
-    def __rshift__(self, multiple_destinations: List[_UsesFromLate[DslElement]]) -> List[_Relationship[Self, DslElement]]:
+    def __rshift__(self, multiple_destinations: List[Union[DslElement, _UsesFromLate[DslElement]]]) -> List[_Relationship[Self, DslElement]]:
         ...
 
     def __rshift__(
             self,
             other: Union[
+                DslElement,
                 str,
                 Tuple[str, str],
                 _RelationshipDescription[DslElement],
-                List[_UsesFromLate[DslElement]]
-            ]) -> Union[_UsesFrom[Self, DslElement], List[_Relationship[Self, DslElement]]]:
-        if isinstance(other, str):
+                List[Union[DslElement, _UsesFromLate[DslElement]]]
+            ]) -> Union[_UsesFrom[Self, DslElement], _Relationship[Self, DslElement], List[_Relationship[Self, DslElement]]]:
+        if isinstance(other, DslElement):
+            return cast(
+                _Relationship[Self, DslElement],
+                cast(
+                    _UsesFrom[Self, DslElement],
+                    _UsesFrom(self)
+                ) >> other
+            )
+        elif isinstance(other, str):
             return _UsesFrom(self, other)
         elif isinstance(other, tuple):
             return _UsesFrom(self, description=other[0], technology=other[1])
         elif isinstance(other, _RelationshipDescription):
             return _UsesFrom(self, description=other._description, technology=other._technology)
-        elif isinstance(other, list):
-            relationships = []
+        elif _is_list_of_dslelements_or_usesfromlates(other):
+            relationships: List[_Relationship[Self, DslElement]] = []
             for dest in other:
-                dest.set_source(self)
-                relationships.append(dest.get_relationship())
-            return cast(List[_Relationship[Self, DslElement]], relationships)
+                if isinstance(dest, _UsesFromLate):
+                    dest.set_source(self)
+                    relationships.append(dest.get_relationship())
+                elif isinstance(dest, DslElement):
+                    relationships.append(
+                        cast(
+                            _Relationship[Self, DslElement],
+                            cast(
+                                _UsesFrom[Self, DslElement],
+                                _UsesFrom(self)
+                            ) >> dest
+                        )
+                    )
+            return relationships
         else:
             raise TypeError(f"Unsupported operand type for >>: '{type(self).__name__}' and {type(other).__name__}")
 

{buildzr-0.0.3 → buildzr-0.0.5}/tests/test_dsl.py

@@ -799,3 +799,48 @@ def test_grouping() -> Optional[None]:
     assert a.container().a1.model.relationships[0].destinationId == b.container().b1.model.id
     assert b.container().b2.component().c1.model.group == "Company 2"
     assert a.model.relationships[1].destinationId == w.software_system().c.model.id
+
+def test_dsl_relationship_without_desc() -> Optional[None]:
+
+    w = Workspace("w")\
+        .contains(
+            Person("User"),
+            SoftwareSystem("Software 1"),
+            SoftwareSystem("Software 2"),
+        )\
+        .where(lambda w: [
+            # TODO: Check why mypy fails here.
+            w.person().user >> w.software_system().software_1,
+        ])
+
+    assert w.person().user.model.relationships[0].description == ""
+    assert w.person().user.model.relationships[0].technology == ""
+    assert w.person().user.model.relationships[0].destinationId == w.software_system().software_1.model.id
+
+def test_dsl_relationship_without_desc_multiple_dest() -> Optional[None]:
+
+    w = Workspace("w")\
+        .contains(
+            Person("User"),
+            SoftwareSystem("Software 1"),
+            SoftwareSystem("Software 2"),
+            SoftwareSystem("Software 3"),
+        )\
+        .where(lambda w: [
+            w.person().user >> [
+                w.software_system().software_1,
+                desc("browses") >> w.software_system().software_2,
+                w.software_system().software_3,
+            ]
+        ])
+
+    assert len(w.person().user.model.relationships) == 3
+    assert not w.person().user.model.relationships[0].description
+    assert not w.person().user.model.relationships[0].technology
+    assert w.person().user.model.relationships[1].description == "browses"
+    assert not w.person().user.model.relationships[1].technology
+    assert not w.person().user.model.relationships[2].description
+    assert not w.person().user.model.relationships[2].technology
+    assert w.person().user.model.relationships[0].destinationId == w.software_system().software_1.model.id
+    assert w.person().user.model.relationships[1].destinationId == w.software_system().software_2.model.id
+    assert w.person().user.model.relationships[2].destinationId == w.software_system().software_3.model.id

buildzr-0.0.3/buildzr/__about__.py

@@ -1 +0,0 @@
-VERSION = "0.0.3"