urban-workflow 0.1.0__tar.gz

urban_workflow-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 black beard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

urban_workflow-0.1.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: urban-workflow
+Version: 0.1.0
+Summary: Moteur de workflow piloté par un DSL métier — portage Python de Black-Beard-Sdk/Workflow, sorties JSON normalisées via urban-json (JSLT).
+Author-email: Gael Beard <gaelgael5@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 black beard
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/gaelgael5/urban-workflow
+Project-URL: Issues, https://github.com/gaelgael5/urban-workflow/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urban-json>=0.2.1
+Provides-Extra: sql
+Requires-Dist: sqlalchemy>=2.0; extra == "sql"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: sqlalchemy>=2.0; extra == "dev"
+Requires-Dist: fastapi>=0.110; extra == "dev"
+Requires-Dist: uvicorn>=0.27; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Dynamic: license-file
+
+# urban-workflow
+
+Moteur de workflow piloté par un **langage dédié** (DSL) — portage Python de
+[Black-Beard-Sdk/Workflow](https://github.com/Black-Beard-Sdk/Workflow)
+(.NET), dont le système de normalisation des sorties JSON est remplacé par
+[urban-json](https://pypi.org/project/urban-json/) (moteur JSLT) : les
+messages produits par le moteur sont décrits par des templates `.jslt`
+déclaratifs, modifiables sans redéploiement.
+
+## Un workflow en quelques lignes
+
+```sql
+NAME ValidationAchat VERSION 1
+MATCHING (Type = 'achat')
+
+DEFINE EVENT  DemandeSoumise 'une demande est déposée';
+DEFINE RULE   MontantInferieur (DECIMAL seuil) 'montant sous le seuil';
+DEFINE ACTION NotifierValideur (TEXT dossier)  'demande d''approbation';
+DEFINE CONST  seuil_auto 500 'approbation automatique sous ce montant';
+
+INITIALIZE WORKFLOW
+    ON EVENT DemandeSoumise RECURSIVE SWITCH Tri
+
+DEFINE STATE Tri 'aiguillage'
+    ON EVENT DemandeSoumise
+        WHEN MontantInferieur(seuil = seuil_auto)
+            SWITCH Approuvee
+        EXECUTE NotifierValideur(dossier = @Workflow.ExternalId)
+            SWITCH EnValidation
+;
+DEFINE STATE Approuvee    'approbation automatique' ;
+DEFINE STATE EnValidation 'en attente d''un valideur'
+    EXPIRE AFTER 3 DAY SWITCH Expiree
+;
+DEFINE STATE Expiree      'sans réponse' ;
+```
+
+```python
+from urban_workflow import (
+    FunctionRegistry, MemoryStorage, Workflow,
+    WorkflowEngine, WorkflowFactory, WorkflowProcessor, WorkflowsConfig,
+)
+from urban_workflow.dsl import parse_config
+from urban_workflow.outputs import default_memory_output
+
+rules = FunctionRegistry("rule")
+rules.add("MontantInferieur", lambda ctx, seuil: float(
+    ctx.incoming_event.extended_datas.get("Montant", 0)) < seuil)
+
+storage = MemoryStorage()
+configs = WorkflowsConfig().add_document(parse_config(SCRIPT, rules=rules))
+processor = WorkflowProcessor(configs, WorkflowFactory())
+processor.load_existing_workflows_by_external_id = (
+    lambda key: storage.get_by(Workflow, key, "external_id"))
+processor.output_actions = default_memory_output(storage)
+engine = WorkflowEngine(processor)
+
+engine.evaluate_event({"Name": "DemandeSoumise", "ExternalId": "DA-42",
+                       "Type": "achat", "Montant": 120})
+```
+
+## Documentation
+
+| Guide | Contenu |
+|---|---|
+| [docs/guide-dsl.md](docs/guide-dsl.md) | **Créer un workflow** : référence complète du langage — création d'instances, transitions `SWITCH`, conditions `WHEN`, actions, expiration, fragments |
+| [docs/guide-integration.md](docs/guide-integration.md) | **L'utiliser dans du code** : règles métier, assemblage du moteur, templates JSLT, chaîne de sorties, événements techniques |
+| [docs/guide-tests.md](docs/guide-tests.md) | **Le tester** : règles pures, configuration, templates, scénarios de bout en bout |
+| [docs/analyse-portage.md](docs/analyse-portage.md) | Analyse du projet source et choix structurants du portage |
+
+English versions: [docs/en/dsl-guide.md](docs/en/dsl-guide.md) ·
+[docs/en/integration-guide.md](docs/en/integration-guide.md) ·
+[docs/en/testing-guide.md](docs/en/testing-guide.md)
+
+## Playground
+
+Un site web local pour écrire les scripts avec **intellisense**,
+diagnostics positionnés, paramétrage des règles métier et simulation
+d'événements sur le vrai moteur — distribution séparée
+[`urban-workflow-playground`](playground/README.md) :
+
+```bash
+pip install urban-workflow-playground
+urban-workflow-playground     # http://127.0.0.1:8777
+```
+
+## Installation et développement
+
+```bash
+pip install -e .[dev]
+python3 -m pytest -q
+```
+
+Dépendance unique du cœur : `urban-json` (qui apporte le runtime ANTLR du
+parseur DSL). Python ≥ 3.10.
+
+## État du portage
+
+Socle, DSL (grammaires ANTLR reprises du source), moteur, templating
+urban-json et persistance SQL (extra `[sql]`, SQLAlchemy Core) sont
+fonctionnels et testés (scénarios de bout en bout *script DSL →
+événements → états → messages*, cycle de vie persisté en SQL), avec CI
+GitHub Actions (tests Python 3.10 → 3.13, lint ruff). Les bugs connus du
+moteur source ne sont pas reproduits — chacun est couvert par un test
+dédié.
+
+## Licence
+
+Voir [LICENSE](LICENSE).

urban_workflow-0.1.0/README.md

@@ -0,0 +1,109 @@
+# urban-workflow
+
+Moteur de workflow piloté par un **langage dédié** (DSL) — portage Python de
+[Black-Beard-Sdk/Workflow](https://github.com/Black-Beard-Sdk/Workflow)
+(.NET), dont le système de normalisation des sorties JSON est remplacé par
+[urban-json](https://pypi.org/project/urban-json/) (moteur JSLT) : les
+messages produits par le moteur sont décrits par des templates `.jslt`
+déclaratifs, modifiables sans redéploiement.
+
+## Un workflow en quelques lignes
+
+```sql
+NAME ValidationAchat VERSION 1
+MATCHING (Type = 'achat')
+
+DEFINE EVENT  DemandeSoumise 'une demande est déposée';
+DEFINE RULE   MontantInferieur (DECIMAL seuil) 'montant sous le seuil';
+DEFINE ACTION NotifierValideur (TEXT dossier)  'demande d''approbation';
+DEFINE CONST  seuil_auto 500 'approbation automatique sous ce montant';
+
+INITIALIZE WORKFLOW
+    ON EVENT DemandeSoumise RECURSIVE SWITCH Tri
+
+DEFINE STATE Tri 'aiguillage'
+    ON EVENT DemandeSoumise
+        WHEN MontantInferieur(seuil = seuil_auto)
+            SWITCH Approuvee
+        EXECUTE NotifierValideur(dossier = @Workflow.ExternalId)
+            SWITCH EnValidation
+;
+DEFINE STATE Approuvee    'approbation automatique' ;
+DEFINE STATE EnValidation 'en attente d''un valideur'
+    EXPIRE AFTER 3 DAY SWITCH Expiree
+;
+DEFINE STATE Expiree      'sans réponse' ;
+```
+
+```python
+from urban_workflow import (
+    FunctionRegistry, MemoryStorage, Workflow,
+    WorkflowEngine, WorkflowFactory, WorkflowProcessor, WorkflowsConfig,
+)
+from urban_workflow.dsl import parse_config
+from urban_workflow.outputs import default_memory_output
+
+rules = FunctionRegistry("rule")
+rules.add("MontantInferieur", lambda ctx, seuil: float(
+    ctx.incoming_event.extended_datas.get("Montant", 0)) < seuil)
+
+storage = MemoryStorage()
+configs = WorkflowsConfig().add_document(parse_config(SCRIPT, rules=rules))
+processor = WorkflowProcessor(configs, WorkflowFactory())
+processor.load_existing_workflows_by_external_id = (
+    lambda key: storage.get_by(Workflow, key, "external_id"))
+processor.output_actions = default_memory_output(storage)
+engine = WorkflowEngine(processor)
+
+engine.evaluate_event({"Name": "DemandeSoumise", "ExternalId": "DA-42",
+                       "Type": "achat", "Montant": 120})
+```
+
+## Documentation
+
+| Guide | Contenu |
+|---|---|
+| [docs/guide-dsl.md](docs/guide-dsl.md) | **Créer un workflow** : référence complète du langage — création d'instances, transitions `SWITCH`, conditions `WHEN`, actions, expiration, fragments |
+| [docs/guide-integration.md](docs/guide-integration.md) | **L'utiliser dans du code** : règles métier, assemblage du moteur, templates JSLT, chaîne de sorties, événements techniques |
+| [docs/guide-tests.md](docs/guide-tests.md) | **Le tester** : règles pures, configuration, templates, scénarios de bout en bout |
+| [docs/analyse-portage.md](docs/analyse-portage.md) | Analyse du projet source et choix structurants du portage |
+
+English versions: [docs/en/dsl-guide.md](docs/en/dsl-guide.md) ·
+[docs/en/integration-guide.md](docs/en/integration-guide.md) ·
+[docs/en/testing-guide.md](docs/en/testing-guide.md)
+
+## Playground
+
+Un site web local pour écrire les scripts avec **intellisense**,
+diagnostics positionnés, paramétrage des règles métier et simulation
+d'événements sur le vrai moteur — distribution séparée
+[`urban-workflow-playground`](playground/README.md) :
+
+```bash
+pip install urban-workflow-playground
+urban-workflow-playground     # http://127.0.0.1:8777
+```
+
+## Installation et développement
+
+```bash
+pip install -e .[dev]
+python3 -m pytest -q
+```
+
+Dépendance unique du cœur : `urban-json` (qui apporte le runtime ANTLR du
+parseur DSL). Python ≥ 3.10.
+
+## État du portage
+
+Socle, DSL (grammaires ANTLR reprises du source), moteur, templating
+urban-json et persistance SQL (extra `[sql]`, SQLAlchemy Core) sont
+fonctionnels et testés (scénarios de bout en bout *script DSL →
+événements → états → messages*, cycle de vie persisté en SQL), avec CI
+GitHub Actions (tests Python 3.10 → 3.13, lint ruff). Les bugs connus du
+moteur source ne sont pas reproduits — chacun est couvert par un test
+dédié.
+
+## Licence
+
+Voir [LICENSE](LICENSE).

urban_workflow-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "urban-workflow"
+version = "0.1.0"
+description = "Moteur de workflow piloté par un DSL métier — portage Python de Black-Beard-Sdk/Workflow, sorties JSON normalisées via urban-json (JSLT)."
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [{ name = "Gael Beard", email = "gaelgael5@gmail.com" }]
+requires-python = ">=3.10"
+dependencies = [
+    "urban-json>=0.2.1",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+]
+
+[project.urls]
+Homepage = "https://github.com/gaelgael5/urban-workflow"
+Issues = "https://github.com/gaelgael5/urban-workflow/issues"
+
+[project.optional-dependencies]
+sql = [
+    "sqlalchemy>=2.0",
+]
+# Le playground est une distribution séparée : pip install urban-workflow-playground
+# (sous-projet playground/ de ce dépôt).
+dev = [
+    "pytest>=7",
+    "ruff>=0.4",
+    "sqlalchemy>=2.0",
+    "fastapi>=0.110",
+    "uvicorn>=0.27",
+    "httpx>=0.27",
+]
+
+[tool.setuptools.packages.find]
+include = ["urban_workflow*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = ["urban_workflow/dsl/generated"]
+
+[tool.ruff.lint]
+# Jeu de règles explicite : la CI ne dépend pas des défauts de ruff.
+select = ["E4", "E7", "E9", "F", "I", "UP", "RUF100"]
+
+[tool.ruff.lint.per-file-ignores]
+# Imports après pytest.importorskip("sqlalchemy") : voulu.
+"tests/test_storage_sql.py" = ["E402"]

urban_workflow-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

urban_workflow-0.1.0/tests/test_config.py

@@ -0,0 +1,152 @@
+"""Tests du modèle de configuration et des builders fluides.
+
+La configuration construite ici reprend celle de ``WorkflowsUnitTest``
+du projet source (``InitializeWorkflow``) : construction à la main, sans
+DSL — le moteur viendra l'exécuter à l'étape suivante.
+"""
+
+import pytest
+
+from urban_workflow import (
+    IncomingEvent,
+    IncomingEventConfig,
+    InitializationOnEventConfig,
+    MissingConfigurationError,
+    MissingStateError,
+    ResultActionConfig,
+    RunContext,
+    StateConfig,
+    TransitionConfig,
+    Workflow,
+    WorkflowConfig,
+    WorkflowsConfig,
+    constants,
+)
+from urban_workflow.values import ContextRef
+
+
+def build_wrk1(version: int = 1) -> WorkflowConfig:
+    """La config du test source InitializeWorkflow."""
+    return (
+        WorkflowConfig(name="wrk1", label="wrk1 config", version=version)
+        .add_initializer(
+            InitializationOnEventConfig(event_name="evnt1", recursive=True).add_switch("State1")
+        )
+        .add_state(
+            StateConfig(name="State1", label="State1").add_event(
+                IncomingEventConfig(name="evnt1").add_transition(
+                    TransitionConfig(target_state_name="State2")
+                )
+            )
+        )
+        .add_state(StateConfig(name="State2", label="State2"))
+    )
+
+
+def test_build_resolves_target_states():
+    config = build_wrk1().build()
+
+    switch = config.initializers["evnt1"].switchs[0]
+    assert switch.target_state is config.states["State1"]
+
+    transition = config.states["State1"].events["evnt1"].transitions[0]
+    assert transition.target_state is config.states["State2"]
+    assert transition.label == "State1 -> State2"
+
+
+def test_build_declares_events_automatically():
+    config = build_wrk1().build()
+    # $_result (technique), evnt1 (initialiseur + état)
+    assert constants.RESULT_ACTION_NAME in config.declared_events
+    assert "evnt1" in config.declared_events
+    assert config.declared_events[constants.RESULT_ACTION_NAME].label != ""
+
+
+def test_build_missing_state_raises():
+    config = WorkflowConfig(name="bad", version=1).add_initializer(
+        InitializationOnEventConfig(event_name="e").add_switch("Nowhere")
+    )
+    with pytest.raises(MissingStateError) as exc:
+        config.build()
+    assert "Nowhere" in str(exc.value)
+
+
+def test_build_is_idempotent():
+    config = build_wrk1()
+    config.build()
+    config.build()  # ne doit pas re-déclarer ni échouer
+    assert len(config.declared_events) == 2
+
+
+def test_evaluate_filter_matching():
+    config = build_wrk1()
+    config.add_filter("Country", "France")
+
+    event_fr = IncomingEvent(name="evnt1")
+    event_fr.extended_datas["Country"] = "France"
+    event_de = IncomingEvent(name="evnt1")
+    event_de.extended_datas["Country"] = "Germany"
+    event_none = IncomingEvent(name="evnt1")
+
+    assert config.evaluate_filter(event_fr) is True
+    assert config.evaluate_filter(event_de) is False
+    assert config.evaluate_filter(event_none) is False
+
+
+def test_workflows_config_get_by_name_and_version():
+    configs = WorkflowsConfig()
+    configs.add_document(build_wrk1(version=1))
+    configs.add_document(build_wrk1(version=2))
+
+    assert configs.get("wrk1", 2).version == 2
+    assert len(configs.get_all("wrk1")) == 2
+    with pytest.raises(MissingConfigurationError):
+        configs.get("wrk1", 99)
+    with pytest.raises(MissingConfigurationError):
+        configs.get("unknown", 1)
+
+
+def test_workflows_config_matching_honors_filters_and_version_selector():
+    configs = WorkflowsConfig()
+    configs.add_document(build_wrk1(version=1))
+    configs.add_document(build_wrk1(version=2))
+
+    event = IncomingEvent(name="evnt1")
+    assert {c.version for c in configs.matching(event)} == {1, 2}
+
+    # Restreint la création aux workflows version 2.
+    configs.set_version_selector("wrk1", 2)
+    assert {c.version for c in configs.matching(event)} == {2}
+
+
+def test_result_action_config_map_and_arguments():
+    action_config = (
+        ResultActionConfig(name="Cut", kind=constants.PUSH_ACTION_NAME)
+        .add_argument("key", "@IncomingEvent.ExternalId")
+        .add_argument("mode", "hard")
+    )
+    assert isinstance(action_config.arguments["key"], ContextRef)
+
+    incoming = IncomingEvent(name="evnt1", external_id="ext-7")
+    ctx = RunContext(workflow=Workflow(), incoming_event=incoming)
+
+    action = action_config.map(ctx)
+    assert action.name == "Cut"
+    assert action.kind == constants.PUSH_ACTION_NAME
+    assert action.event_date is not None
+    # Les arguments restent paresseux jusqu'à la résolution explicite.
+    assert action.resolve_arguments(ctx) == {"key": "ext-7", "mode": "hard"}
+
+
+def test_rule_actions_grouped_by_shared_rule():
+    def always(ctx):
+        return True
+
+    state = StateConfig(name="S")
+    state.add_incoming_actions(always, ResultActionConfig(name="A"))
+    state.add_incoming_actions(always, ResultActionConfig(name="B"))
+    state.add_incoming_actions(None, ResultActionConfig(name="C"))
+
+    assert len(state.incoming_rules) == 2  # 'always' regroupé, None séparé
+    grouped = next(r for r in state.incoming_rules if r.when_rule is always)
+    assert [a.name for a in grouped.actions] == ["A", "B"]