ISSUE #198

* Rename classes to increase naming consistency.

Author: Sergio García Prado

packages/core/minos-microservice-saga/minos/saga/__init__.py

@@ -9,28 +9,28 @@
 )
 from .definitions import (
     ConditionalSagaStep,
-    ConditionalSagaStepMeta,
-    ConditionalSagaStepWrapper,
+    ConditionalSagaStepDecoratorMeta,
+    ConditionalSagaStepDecoratorWrapper,
     ElseThenAlternative,
     ElseThenAlternativeMeta,
     ElseThenAlternativeWrapper,
     IfThenAlternative,
     IfThenAlternativeMeta,
     IfThenAlternativeWrapper,
     LocalSagaStep,
-    LocalSagaStepMeta,
-    LocalSagaStepWrapper,
-    OnStepDecorator,
+    LocalSagaStepDecoratorMeta,
+    LocalSagaStepDecoratorWrapper,
+    OnSagaStepDecorator,
     RemoteSagaStep,
-    RemoteSagaStepMeta,
-    RemoteSagaStepWrapper,
+    RemoteSagaStepDecoratorMeta,
+    RemoteSagaStepDecoratorWrapper,
     Saga,
-    SagaClassMeta,
-    SagaClassWrapper,
+    SagaDecoratorMeta,
+    SagaDecoratorWrapper,
     SagaOperation,
     SagaStep,
-    SagaStepMeta,
-    SagaStepWrapper,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 from .exceptions import (
     AlreadyCommittedException,

packages/core/minos-microservice-saga/minos/saga/definitions/__init__.py

@@ -3,29 +3,29 @@
 )
 from .saga import (
     Saga,
-    SagaClassMeta,
-    SagaClassWrapper,
+    SagaDecoratorMeta,
+    SagaDecoratorWrapper,
 )
 from .steps import (
     ConditionalSagaStep,
-    ConditionalSagaStepMeta,
-    ConditionalSagaStepWrapper,
+    ConditionalSagaStepDecoratorMeta,
+    ConditionalSagaStepDecoratorWrapper,
     ElseThenAlternative,
     ElseThenAlternativeMeta,
     ElseThenAlternativeWrapper,
     IfThenAlternative,
     IfThenAlternativeMeta,
     IfThenAlternativeWrapper,
     LocalSagaStep,
-    LocalSagaStepMeta,
-    LocalSagaStepWrapper,
-    OnStepDecorator,
+    LocalSagaStepDecoratorMeta,
+    LocalSagaStepDecoratorWrapper,
+    OnSagaStepDecorator,
     RemoteSagaStep,
-    RemoteSagaStepMeta,
-    RemoteSagaStepWrapper,
+    RemoteSagaStepDecoratorMeta,
+    RemoteSagaStepDecoratorWrapper,
     SagaStep,
-    SagaStepMeta,
-    SagaStepWrapper,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 from .types import (
     ConditionCallback,

packages/core/minos-microservice-saga/minos/saga/definitions/saga.py

@@ -37,37 +37,35 @@
     LocalSagaStep,
     RemoteSagaStep,
     SagaStep,
-    SagaStepWrapper,
+    SagaStepDecoratorWrapper,
 )
 from .types import (
     LocalCallback,
     RequestCallBack,
 )
 
-SagaClass = TypeVar("SagaClass", bound=type)
-
 
 @runtime_checkable
-class SagaClassWrapper(Protocol):
+class SagaDecoratorWrapper(Protocol):
     """TODO"""
 
-    meta: SagaClassMeta
+    meta: SagaDecoratorMeta
 
 
-class SagaClassMeta:
+class SagaDecoratorMeta:
     """TODO"""
 
-    _class: SagaClass
+    _inner: type
     _definition: Saga
 
-    def __init__(self, func: SagaClass, saga: Saga):
-        self._class = func
+    def __init__(self, func: type, saga: Saga):
+        self._inner = func
         self._definition = saga
 
     @cached_property
     def definition(self) -> Saga:
         """TODO"""
-        steps = getmembers(self._class, predicate=lambda x: isinstance(x, SagaStepWrapper))
+        steps = getmembers(self._inner, predicate=lambda x: isinstance(x, SagaStepDecoratorWrapper))
         steps = list(map(lambda member: member[1].meta.definition, steps))
         for step in steps:
             if step.order is None:
@@ -111,8 +109,8 @@ def __init__(
             self.local_step(commit)
             self.committed = True
 
-    def __call__(self, type_: TP) -> Union[TP, SagaClassWrapper]:
-        type_.meta = SagaClassMeta(type_, self)
+    def __call__(self, type_: TP) -> Union[TP, SagaDecoratorWrapper]:
+        type_.meta = SagaDecoratorMeta(type_, self)
         return type_
 
     @classmethod

packages/core/minos-microservice-saga/minos/saga/definitions/steps/__init__.py

@@ -1,13 +1,13 @@
 from .abc import (
-    OnStepDecorator,
+    OnSagaStepDecorator,
     SagaStep,
-    SagaStepMeta,
-    SagaStepWrapper,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 from .conditional import (
     ConditionalSagaStep,
-    ConditionalSagaStepMeta,
-    ConditionalSagaStepWrapper,
+    ConditionalSagaStepDecoratorMeta,
+    ConditionalSagaStepDecoratorWrapper,
     ElseThenAlternative,
     ElseThenAlternativeMeta,
     ElseThenAlternativeWrapper,
@@ -17,11 +17,11 @@
 )
 from .local import (
     LocalSagaStep,
-    LocalSagaStepMeta,
-    LocalSagaStepWrapper,
+    LocalSagaStepDecoratorMeta,
+    LocalSagaStepDecoratorWrapper,
 )
 from .remote import (
     RemoteSagaStep,
-    RemoteSagaStepMeta,
-    RemoteSagaStepWrapper,
+    RemoteSagaStepDecoratorMeta,
+    RemoteSagaStepDecoratorWrapper,
 )

packages/core/minos-microservice-saga/minos/saga/definitions/steps/abc.py

@@ -44,23 +44,21 @@
         RemoteSagaStep,
     )
 
-T = TypeVar("T")
-
 
 @runtime_checkable
-class SagaStepWrapper(Protocol):
+class SagaStepDecoratorWrapper(Protocol):
     """TODO"""
 
-    meta: SagaStepMeta
+    meta: SagaStepDecoratorMeta
 
 
-class SagaStepMeta:
+class SagaStepDecoratorMeta:
     """TODO"""
 
-    _inner: T
+    _inner: Any
     _definition: SagaStep
 
-    def __init__(self, inner: T, definition: SagaStep):
+    def __init__(self, inner: Any, definition: SagaStep):
         self._inner = inner
         self._definition = definition
 
@@ -73,10 +71,10 @@ def definition(self) -> SagaStep:
 FN = TypeVar("FN", bound=Callable)
 
 
-class OnStepDecorator(Generic[FN]):
+class OnSagaStepDecorator(Generic[FN]):
     """ "TODO"""
 
-    def __init__(self, attr_name: [str] = None, step_meta: Optional[SagaStepMeta] = None):
+    def __init__(self, attr_name: [str] = None, step_meta: Optional[SagaStepDecoratorMeta] = None):
         if attr_name is None or step_meta is None:
             raise ValueError("TODO")
         self.step_meta = step_meta
@@ -124,7 +122,7 @@ def _from_raw(cls, raw: dict[str, Any]) -> SagaStep:
         raise NotImplementedError
 
     @abstractmethod
-    def __call__(self, func: Callable) -> SagaStepWrapper:
+    def __call__(self, func: Callable) -> SagaStepDecoratorWrapper:
         """TODO"""
 
     def conditional_step(self, *args, **kwargs) -> ConditionalSagaStep:

packages/core/minos-microservice-saga/minos/saga/definitions/steps/conditional.py

@@ -42,25 +42,25 @@
 )
 from .abc import (
     SagaStep,
-    SagaStepMeta,
-    SagaStepWrapper,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 
 if TYPE_CHECKING:
     from ..saga import (
         Saga,
     )
 
-TP = TypeVar("TP", bound=type)
+ConditionalSagaStepClass = TypeVar("ConditionalSagaStepClass", bound=type)
 
 
-class ConditionalSagaStepWrapper(SagaStepWrapper):
+class ConditionalSagaStepDecoratorWrapper(SagaStepDecoratorWrapper):
     """TODO"""
 
-    meta: ConditionalSagaStepMeta
+    meta: ConditionalSagaStepDecoratorMeta
 
 
-class ConditionalSagaStepMeta(SagaStepMeta):
+class ConditionalSagaStepDecoratorMeta(SagaStepDecoratorMeta):
     """TODO"""
 
     _definition: ConditionalSagaStep
@@ -80,8 +80,9 @@ def definition(self):
 
         else_then_alternatives = getmembers(
             self._inner,
-            predicate=lambda x: isinstance(x, ElseThenAlternativeWrapper)
-            and isinstance(x.meta, ElseThenAlternativeMeta),
+            predicate=(
+                lambda x: isinstance(x, ElseThenAlternativeWrapper) and isinstance(x.meta, ElseThenAlternativeMeta)
+            ),
         )
         else_then_alternatives = list(map(lambda member: member[1].meta.alternative, else_then_alternatives))
         if len(else_then_alternatives) > 1:
@@ -130,8 +131,8 @@ def _from_raw(cls, raw: dict[str, Any], **kwargs) -> ConditionalSagaStep:
 
         return cls(**current)
 
-    def __call__(self, type_: TP) -> Union[TP, ConditionalSagaStepMeta]:
-        meta = ConditionalSagaStepMeta(type_, self)
+    def __call__(self, type_: ConditionalSagaStepClass) -> ConditionalSagaStepClass:
+        meta = ConditionalSagaStepDecoratorMeta(type_, self)
         type_.meta = meta
         return type_
 

packages/core/minos-microservice-saga/minos/saga/definitions/steps/local.py

@@ -38,22 +38,22 @@
     LocalCallback,
 )
 from .abc import (
-    OnStepDecorator,
+    OnSagaStepDecorator,
     SagaStep,
-    SagaStepMeta,
-    SagaStepWrapper,
+    SagaStepDecoratorMeta,
+    SagaStepDecoratorWrapper,
 )
 
 
-class LocalSagaStepWrapper(SagaStepWrapper):
+class LocalSagaStepDecoratorWrapper(SagaStepDecoratorWrapper):
     """TODO"""
 
-    meta: LocalSagaStepMeta
-    on_failure: type[OnStepDecorator[LocalCallback]]
+    meta: LocalSagaStepDecoratorMeta
+    on_failure: type[OnSagaStepDecorator[LocalCallback]]
     __call__: LocalCallback
 
 
-class LocalSagaStepMeta(SagaStepMeta):
+class LocalSagaStepDecoratorMeta(SagaStepDecoratorMeta):
     """TODO"""
 
     _definition: LocalSagaStep
@@ -72,10 +72,10 @@ def definition(self):
         return self._definition
 
     @cached_property
-    def on_failure(self) -> OnStepDecorator:
+    def on_failure(self) -> OnSagaStepDecorator:
         """TODO"""
         # noinspection PyTypeChecker
-        return partial(OnStepDecorator, step_meta=self, attr_name="_on_failure")
+        return partial(OnSagaStepDecorator, step_meta=self, attr_name="_on_failure")
 
 
 class LocalSagaStep(SagaStep):
@@ -105,8 +105,8 @@ def _from_raw(cls, raw: dict[str, Any]) -> LocalSagaStep:
 
         return cls(**raw)
 
-    def __call__(self, func: LocalCallback) -> LocalSagaStepWrapper:
-        meta = LocalSagaStepMeta(func, self)
+    def __call__(self, func: LocalCallback) -> LocalSagaStepDecoratorWrapper:
+        meta = LocalSagaStepDecoratorMeta(func, self)
         func.meta = meta
         func.on_failure = meta.on_failure
         # noinspection PyTypeChecker