Ajustes no CI

.github/fluxos de trabalho/ci.yml

@@ -0,0 +1,92 @@
+name: Upload Python Package
+
+on:
+  push:
+
+jobs:
+  executa_black:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Realiza o checkout
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+
+    - name: Instala Poetry
+    - uses: Gr1N/setup-poetry@v7
+
+    - name: Instala dependências
+      run: poetry install
+
+    - name: Executa black
+      run: poetry run black --check flunt
+
+jobs:
+  executa_isort:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Realiza o checkout
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+
+    - name: Instala Poetry
+    - uses: Gr1N/setup-poetry@v7
+
+    - name: Instala dependências
+      run: poetry install
+
+    - name: Executa isort
+      run: poetry run isort --check flunt
+
+jobs:
+  executa_pydocstyle:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Realiza o checkout
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+
+    - name: Instala Poetry
+    - uses: Gr1N/setup-poetry@v7
+
+    - name: Instala dependências
+      run: poetry install
+
+    - name: Executa pydocstyle
+      run: poetry run pydocstyle flunt
+
+jobs:
+  executa_pytest:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Realiza o checkout
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.10'
+
+    - name: Instala Poetry
+    - uses: Gr1N/setup-poetry@v7
+
+    - name: Instala dependências
+      run: poetry install
+
+    - name: Executa test
+      run: poetry run pytest

README.md

@@ -5,6 +5,12 @@ Python implementation of Domain Notification Pattern based in [Flunt](https://gi
 [![PyPI Latest Release](https://img.shields.io/pypi/v/flunt.svg)](https://pypi.org/project/flunt/)
 [![Downloads](https://pepy.tech/badge/flunt)](https://pepy.tech/project/flunt)
 
+Flunt é uma forma de implementar um padrão de notificações em sua aplicação para concentrar erros e mudança em determinadas ações e entidades.
+
+O Flunt nasceu de duas necessidades, a implementação do Domain Notification Pattern para substituir Exceptions a nível de domínio na aplicação e para reduzir a quantidade de IFs (Complexidade) utilizando uma abordagem por contratos.
+
+Desta forma, basicamente o que Flunt faz é adicionar uma lista de Notification (Notificações) a sua classe e diversos métodos para interagir com ela.
+
 ## Python Version
 
 - [Python 3.10](https://www.python.org/)

flunt/__init__.py

@@ -1 +1,2 @@
-__version__ = '0.1.0'
+"""Version Software."""
+__version__ = "0.1.1"

flunt/contract.py

@@ -1,8 +1,9 @@
 """Module Contract."""
-from flunt.notification import Notification
-from flunt.notifiable import Notifiable
 import re
 
+from flunt.notifiable import Notifiable
+from flunt.notification import Notification
+
 
 class Contract(Notifiable):
     """Class Contract."""
@@ -18,9 +19,7 @@ def has_min_len(self, value, minimum, field, message):
         :return: self
         """
         if not value or len(value) < minimum:
-            self.add_notification(
-                Notification(field, message)
-            )
+            self.add_notification(Notification(field, message))
 
         return self
 
@@ -34,18 +33,13 @@ def is_email(self, value, field, message):
         :return: self
         """
         if not self._valid_email(value):
-            self.add_notification(
-                Notification(field, message)
-            )
+            self.add_notification(Notification(field, message))
 
         return self
 
     def _valid_email(self, value):
-        return re.match(
-            r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)",
-            value,
-            re.IGNORECASE
-        )
+        regex = r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)"
+        return re.match(regex, value, re.IGNORECASE)
 
     def requires(self, value, field):
         """Require.
@@ -57,7 +51,7 @@ def requires(self, value, field):
         """
         if not value:
             self.add_notification(
-                Notification(field, 'Campo preenchimento obrigatório')
+                Notification(field, "Campo preenchimento obrigatório")
             )
 
         return self

flunt/notifiable.py

@@ -17,8 +17,8 @@ def add_notification(self, notification: Notification):
         self._notifications.append(notification)
 
     def add_notifications_of_contract(self, *notifications):
+        """Add notification of contract object."""
         self._notifications += self._filter_and_map_notifiables(notifications)
-        # self._notifications += self._filter_notifications(notifications)
 
     def _filter_and_map_notifiables(self, notifications):
         return [
@@ -56,4 +56,5 @@ def is_valid(self) -> bool:
         return False
 
     def __str__(self):
+        """Print object string."""
         return self._notifications.__str__()

flunt/notification.py

@@ -10,4 +10,6 @@ def __init__(self, field: str, message: str) -> None:
         self.message: str = message
 
     def __str__(self):
-        return '{}field: {}, message: {}{}'.format('{', self.field, self.message, '}')
+        """Print object string."""
+        string = "{}field: {}, message: {}{}"
+        return string.format("{", self.field, self.message, "}")