feat(poly sync): sort the bricks to add by brick type and alphabetically (#457)

* fix(poly sync): sorting the bricks to update in the pyproject.toml

* bump Poetry plugin to 1.53.0

* bump CLI to 1.49.0

Author: DavidVujic

components/polylith/sync/update.py

@@ -1,3 +1,5 @@
+import itertools
+import operator
 from functools import reduce
 from pathlib import Path
 from typing import List, Union
@@ -28,6 +30,10 @@ def to_key_value_include(acc: dict, package: dict) -> dict:
     return {**acc, **{include: brick}}
 
 
+def sort_bricks(bricks: dict) -> List[tuple]:
+    return sorted(bricks.items(), key=lambda i: i[0])
+
+
 def generate_updated_pep_621_project(data: TOMLDocument, bricks_to_add: dict) -> str:
     copy = copy_toml_data(data)
 
@@ -40,7 +46,7 @@ def generate_updated_pep_621_project(data: TOMLDocument, bricks_to_add: dict) ->
     if not copy["tool"]["polylith"].get("bricks"):
         copy["tool"]["polylith"]["bricks"] = {}
 
-    for k, v in bricks_to_add.items():
+    for k, v in sort_bricks(bricks_to_add):
         copy["tool"]["polylith"]["bricks"][k] = v
 
     return tomlkit.dumps(copy)
@@ -55,21 +61,39 @@ def generate_updated_hatch_project(data: TOMLDocument, bricks_to_add: dict) -> s
     if not has_polylith and has_hatch:
         copy = copy_toml_data(data)
 
-        for k, v in bricks_to_add.items():
+        for k, v in sort_bricks(bricks_to_add):
             copy["tool"]["hatch"]["build"]["force-include"][k] = v
 
         return tomlkit.dumps(copy)
 
     return generate_updated_pep_621_project(data, bricks_to_add)
 
 
+def sort_fn_by_from(data: dict) -> str:
+    return data["from"]
+
+
+def sort_fn_by_include(data: dict) -> str:
+    return data["include"]
+
+
+def to_sorted_packages(packages: List[dict]) -> List[dict]:
+    sorted_by_brick_type = sorted(packages, key=sort_fn_by_from)
+    grouped = itertools.groupby(sorted_by_brick_type, key=sort_fn_by_from)
+
+    groups = [list(g) for _k, g in grouped]
+    flattened: List[dict] = reduce(operator.iadd, groups, [])
+
+    return sorted(flattened, key=sort_fn_by_include)
+
+
 def generate_updated_poetry_project(data: TOMLDocument, packages: List[dict]) -> str:
     copy = copy_toml_data(data)
 
     if copy["tool"]["poetry"].get("packages") is None:
         copy["tool"]["poetry"].add("packages", [])
 
-    for package in packages:
+    for package in to_sorted_packages(packages):
         copy["tool"]["poetry"]["packages"].append(package)
 
     copy["tool"]["poetry"]["packages"].multiline(True)

projects/poetry_polylith_plugin/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "poetry-polylith-plugin"
-version = "1.52.2"
+version = "1.53.0"
 description = "A Poetry plugin that adds tooling support for the Polylith Architecture"
 authors = ["David Vujic"]
 homepage = "https://davidvujic.github.io/python-polylith-docs/"

projects/polylith_cli/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "polylith-cli"
-version = "1.48.3"
+version = "1.49.0"
 description = "Python tooling support for the Polylith Architecture"
 authors = ['David Vujic']
 homepage = "https://davidvujic.github.io/python-polylith-docs/"

test/components/polylith/sync/test_update.py

@@ -1,9 +1,16 @@
 from pathlib import Path
+from typing import Union
 
 import tomlkit
 from polylith.sync import update
 
 
+def parse(data: Union[str, None]) -> dict:
+    parsed = tomlkit.parse(data) if data else {}
+
+    return parsed or {}
+
+
 def test_brick_to_pyproject_package():
     ns = "unit_test"
     brick = "greet"
@@ -70,75 +77,126 @@ def test_bricks_to_pyproject_packages():
     "components/hello/third": "hello/third",
 }
 
+unsorted_packages = [
+    {"include": "hello/c", "from": "components"},
+    {"include": "hello/a", "from": "bases"},
+    {"include": "hello/b", "from": "components"},
+]
+
+expected_sorted_pep621_bricks = {
+    "bases/hello/first": "hello/first",
+    "bases/hello/a": "hello/a",
+    "components/hello/b": "hello/b",
+    "components/hello/c": "hello/c",
+}
 
-def test_generate_updated_poetry_project():
-    data = tomlkit.parse(
-        """\
+poetry_project_data = """\
 [tool.poetry]
 packages = [{include = "hello/first", from = "bases"}]
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 """
-    )
 
-    updated = update.generate_updated_project(data, packages[1:])
-
-    res = tomlkit.parse(updated)["tool"]["poetry"]["packages"]
-
-    assert res == packages
 
-
-def test_generate_updated_hatch_project_with_existing_polylith_sections():
-    data = tomlkit.parse(
-        """\
+hatchling_build_system = """\
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
+"""
+
+hatchling_project_data = """\
+{build_system}
 
 [tool.polylith.bricks]
 "bases/hello/first" = "hello/first"
-"""
-    )
+""".format(
+    build_system=hatchling_build_system
+)
+
+hatch_specific_project_data = """\
+{build_system}
+
+[tool.hatch.build.force-include]
+"bases/hello/first" = "hello/first"
+""".format(
+    build_system=hatchling_build_system
+)
+
+
+def test_generate_updated_poetry_project():
+    data = tomlkit.parse(poetry_project_data)
+
+    updated = update.generate_updated_project(data, packages[1:])
+
+    res = parse(updated)["tool"]["poetry"]["packages"]
+
+    assert res == packages
+
+
+def test_generate_updated_poetry_project_with_the_bricks_to_update_sorted():
+    data = tomlkit.parse(poetry_project_data)
+
+    expected = [
+        {"include": "hello/first", "from": "bases"},
+        {"include": "hello/a", "from": "bases"},
+        {"include": "hello/b", "from": "components"},
+        {"include": "hello/c", "from": "components"},
+    ]
+
+    updated = update.generate_updated_project(data, unsorted_packages)
+
+    res = parse(updated)["tool"]["poetry"]["packages"]
+
+    assert res == expected
+
+
+def test_generate_updated_hatch_project_with_existing_polylith_sections():
+    data = tomlkit.parse(hatchling_project_data)
 
     updated = update.generate_updated_project(data, packages[1:])
 
-    res = tomlkit.parse(updated)["tool"]["polylith"]["bricks"]
+    res = parse(updated)["tool"]["polylith"]["bricks"]
 
     assert res == expected_hatch_packages
 
 
+def test_generate_updated_pep621_project_with_the_bricks_to_update_sorted():
+    data = tomlkit.parse(hatchling_project_data)
+
+    updated = update.generate_updated_project(data, unsorted_packages)
+
+    res = parse(updated)["tool"]["polylith"]["bricks"]
+
+    assert list(res.keys()) == list(expected_sorted_pep621_bricks.keys())
+
+
 def test_generate_updated_hatch_project_with_missing_brick_config():
-    data = tomlkit.parse(
-        """\
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-"""
-    )
+    data = tomlkit.parse(hatchling_build_system)
 
     updated = update.generate_updated_project(data, packages)
 
-    res = tomlkit.parse(updated)["tool"]["polylith"]["bricks"]
+    res = parse(updated)["tool"]["polylith"]["bricks"]
 
     assert res == expected_hatch_packages
 
 
 def test_generate_updated_hatch_project_with_existing_force_include():
-    data = tomlkit.parse(
-        """\
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[tool.hatch.build.force-include]
-"bases/hello/first" = "hello/first"
-"""
-    )
+    data = tomlkit.parse(hatch_specific_project_data)
 
     updated = update.generate_updated_project(data, packages[1:])
 
-    res = tomlkit.parse(updated)["tool"]["hatch"]["build"]["force-include"]
+    res = parse(updated)["tool"]["hatch"]["build"]["force-include"]
 
     assert res == expected_hatch_packages
+
+
+def test_generate_updated_hatch_project_force_include_with_sorted_bricks():
+    data = tomlkit.parse(hatch_specific_project_data)
+
+    updated = update.generate_updated_project(data, unsorted_packages)
+
+    res = parse(updated)["tool"]["hatch"]["build"]["force-include"]
+
+    assert list(res.keys()) == list(expected_sorted_pep621_bricks.keys())