cici-tools 0.19.1__py3-none-any.whl → 0.19.2__py3-none-any.whl

cici/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.19.1'
-__version_tuple__ = version_tuple = (0, 19, 1)
+__version__ = version = '0.19.2'
+__version_tuple__ = version_tuple = (0, 19, 2)
 
-__commit_id__ = commit_id = 'ga17385576'
+__commit_id__ = commit_id = 'g5f755c70a'

cici/providers/gitlab/normalizers.py

@@ -3,7 +3,9 @@
 
 from typing import Any, Union
 
-from ruamel.yaml.scalarstring import ScalarString
+from ruamel.yaml.scalarstring import FoldedScalarString, ScalarString
+
+FOLDED_SCALAR_FOLD_POINTS = {}
 
 
 # Recursivley convert ruamel ScalarStrng objects into plain str """
@@ -11,7 +13,15 @@ from ruamel.yaml.scalarstring import ScalarString
 # they will be turned into plain "foo" which msgspec can handle
 # test this frst, test for each of the ifs and make sure the nesting is right.
 # do simplest tests first, so one that is empty etc. Need to verify.
+#
+# Keep fold_pos for folded scalar strings, if strings aren't changed
+# then re-use fold_pos instead of trying to find best fold positions
 def normalize_scalars(obj):
+    if isinstance(obj, FoldedScalarString):
+        full_str = str(obj)
+        if hasattr(obj, "fold_pos"):
+            FOLDED_SCALAR_FOLD_POINTS[full_str] = obj.fold_pos
+        return full_str
     if isinstance(obj, ScalarString):
         return str(obj)
     elif isinstance(obj, dict):
@@ -24,13 +34,6 @@ def normalize_scalars(obj):
         return obj
 
 
-# bridge between raw YAML and ruamels quirky Python objects
-# and the strict Job/File models
-def normalize_all(data: dict) -> dict:
-    # Apply all normalizations for comparisons
-    return normalize_variables(normalize_jobs_in_data(data))
-
-
 def normalize_variables(data: dict, *, inside_job: bool = False) -> dict:
     # Normalize variables: keep top-level structured, flatten job-level
     # inside_job is going to tell me if i am currently in a job definition or not

cici/providers/gitlab/yaml_style.py

@@ -10,26 +10,30 @@ from ruamel.yaml.scalarstring import (
     PreservedScalarString,
 )
 
+from .normalizers import FOLDED_SCALAR_FOLD_POINTS
+
 
 # to force ruamel.yml to always emit double quoted strings """" and not single "''"
 def always_double_quoted(dumper, data):
     return dumper.represent_scalar("tag:yaml.org,2002:str", data, style='"')
 
 
-def wrap_if_long(s: str, width: int = 120) -> str:
-    # Wrap long strings into multiple lines for YAML folding.
-    if len(s) <= width:
-        return s
-    # break on spaces without splitting words
-    parts = []
-    while len(s) > width:
-        split_at = s.rfind(" ", 0, width)
-        if split_at == -1:
-            split_at = width
-        parts.append(s[:split_at].rstrip())
-        s = s[split_at:].lstrip()
-    parts.append(s)
-    return "\n".join(parts)
+# Return indexes of spaces where a long string should fold into multiple lines.
+# fold_pos is highest index of a space < width, if no space then lowest index > width
+def get_fold_positions(s: str, width: int = 120) -> list[int]:
+    all_pos = []
+    start_pos = 0
+    while start_pos + width < len(s):
+        end_pos = start_pos + width
+        fold_pos = s.rfind(" ", start_pos, end_pos)
+        if fold_pos == -1:
+            fold_pos = s.find(" ", end_pos)
+        if fold_pos > -1:
+            all_pos.append(fold_pos)
+            start_pos = fold_pos + 1
+        else:
+            start_pos = len(s)
+    return all_pos
 
 
 # handling string literals
@@ -44,6 +48,13 @@ def make_scalar_string(line: str, quote: bool = False):
     if "\n" in unindented:
         return PreservedScalarString(line)
 
+    # if it was a folded scalar string before, make it one again
+    # and re-use fold_pos instead of trying to find good breakpoints
+    if unindented in FOLDED_SCALAR_FOLD_POINTS:
+        folded = FoldedScalarString(unindented)
+        folded.fold_pos = FOLDED_SCALAR_FOLD_POINTS[unindented]  # type: ignore[attr-defined]
+        return folded
+
     # fix extra - >- between lines accidentally created with echo commands
     if unindented.startswith("echo "):
         stripped = unindented.strip()
@@ -77,7 +88,9 @@ def make_scalar_string(line: str, quote: bool = False):
 
     # Multi-command sequences get folded
     if any(sym in unindented for sym in ("&&", ";", "\\")):
-        return FoldedScalarString(wrap_if_long(unindented))
+        folded = FoldedScalarString(unindented)
+        folded.fold_pos = get_fold_positions(unindented)  # type: ignore[attr-defined]
+        return folded
 
     # Long assignments get folded
     if (
@@ -85,7 +98,9 @@ def make_scalar_string(line: str, quote: bool = False):
         and not unindented.startswith(("export ", "set ", "$"))
         and len(unindented) > 100
     ):
-        return FoldedScalarString(wrap_if_long(unindented))
+        folded = FoldedScalarString(unindented)
+        folded.fold_pos = get_fold_positions(unindented)  # type: ignore[attr-defined]
+        return folded
 
     # Explicit quoting when requested
     if quote:
@@ -114,7 +129,6 @@ def style_scalars(
         styled: dict[str, Any] = {}
 
         for k, v in list(obj.items()):
-            v = obj[k]
             # 1. keep GitLab workflow 'if' rules unquoted
             if k == "if" and isinstance(v, str):
                 styled[k] = v
@@ -283,7 +297,6 @@ def style_scalars(
             # 9. everything else, recurse normally
             else:
                 styled[k] = style_scalars(v, quote_keys=quote_keys, parent_key=k)
-
         # reinsert any keys skipped during iteration ie dependencies
         for k, v in obj.items():
             if k not in styled:
@@ -308,7 +321,7 @@ def style_scalars(
                 elif parent_key in {"script", "before_script", "after_script"}:
                     stripped_item = item.strip()
 
-                    # keep raw shell assignements in plain text (avoid escaping inside quotes)
+                    # keep raw shell assignments in plain text (avoid escaping inside quotes)
                     if "=" in stripped_item.split()[0] and not stripped_item.startswith(
                         "$"
                     ):

cici/utils.py

@@ -1,7 +1,6 @@
 # SPDX-FileCopyrightText: UL Research Institutes
 # SPDX-License-Identifier: Apache-2.0
 
-from typing import Any, Union
 
 from ruamel.yaml.scalarstring import (
     DoubleQuotedScalarString,
@@ -31,10 +30,6 @@ def merge_dict(orig: dict, new: dict) -> dict:
     return final
 
 
-def make_multiline_string(line):
-    return PreservedScalarString(line)
-
-
 def make_scalar_string(line, quote=False):
     if "\n" in line.strip():
         return PreservedScalarString(line)
@@ -43,25 +38,3 @@ def make_scalar_string(line, quote=False):
     elif quote:
         return DoubleQuotedScalarString(line)
     return line
-
-
-def make_quoted_string(line):
-    return make_scalar_string(line, quote=True)
-
-
-def make_scalar_list(value: list[str]) -> list[Any]:
-    return [make_scalar_string(line) for line in value]
-
-
-def make_quoted_list(value: list[str]) -> list[Any]:
-    return [make_scalar_string(line, quote=True) for line in value]
-
-
-def make_quoted_list_or_string(object: Union[str, list[str]]) -> list[Any]:
-    if isinstance(object, str):
-        return make_quoted_string(object)
-    return make_quoted_list(object)
-
-
-def make_quoted_dict(object):
-    return {key: make_quoted_string(value) for key, value in object.items()}

{cici_tools-0.19.1.dist-info → cici_tools-0.19.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cici-tools
-Version: 0.19.1
+Version: 0.19.2
 Summary: Continuous Integration Catalog Interface
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{cici_tools-0.19.1.dist-info → cici_tools-0.19.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
 cici/__init__.py,sha256=wdYYpZKxK2omc_mRJgPj86Ec-QwoB4noZzlk71sBjnk,87
 cici/__main__.py,sha256=TWDBrcS5vXSclLWLm0Iu3uUXOkDw0PzcJ8a0zd7_ClU,150
-cici/_version.py,sha256=e2Y37v9OC7SXPPTtw19chVDtxRNj-VB7gCjzPIJI0-U,714
+cici/_version.py,sha256=wysr5h4NZ2DOzX3llE1w4f1vytIkeVD-cG6j7-DuaMI,714
 cici/constants.py,sha256=ydShHTAbuanWWXeg9tJZ5GLm65M41AKmIibUheKV5nw,913
 cici/exceptions.py,sha256=JMpcD5YjYwKdn65D0iOEchXiAgIVsKApAyngCTwVgI4,139
 cici/main.py,sha256=ceH9s7i2XdB-mpUtDWuzLVn9TZHiwmsq-daZOgB9oRI,748
 cici/paths.py,sha256=R-zBlX70uUJKR-ttGmZ7gI8iIKdxz9hLN1bP1pSXZxI,1103
 cici/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cici/utils.py,sha256=E6GrD6qCvsFqaR-fhsuBf8qotxyUO2ZdOoKj2vRUUHs,1917
+cici/utils.py,sha256=sC5GdaRlzgyxZg5HnB-HYtSF0tQQt3NQJMQZZphzowU,1202
 cici/cli/__init__.py,sha256=wdYYpZKxK2omc_mRJgPj86Ec-QwoB4noZzlk71sBjnk,87
 cici/cli/bundle.py,sha256=sTcbWiNz_k5OgJVC7XAG5KaHGQZmWLi1Fqdg3JENHDg,3929
 cici/cli/readme.py,sha256=w2-Pi2aDxWGcLMnVEUmejItAneMIqHj0QiR4foFcHYs,2475
@@ -21,10 +21,10 @@ cici/providers/__init__.py,sha256=wdYYpZKxK2omc_mRJgPj86Ec-QwoB4noZzlk71sBjnk,87
 cici/providers/gitlab/__init__.py,sha256=8ej6k3hd25UFOGFhHymLa2mvz9hEwMjdxyu66hnJwOQ,259
 cici/providers/gitlab/constants.py,sha256=nA36aqGvwBBood8lTFJueEY8lKEsOVjkp6ciMjAeKJA,1786
 cici/providers/gitlab/models.py,sha256=MEQYYWeHtMpdSS1zjpxcBC3jXrZdmant98HakeNKXKc,7366
-cici/providers/gitlab/normalizers.py,sha256=EFQiJzRDkoahes0zwIMahuVC3DOy9A97eZDhMXdamno,4762
+cici/providers/gitlab/normalizers.py,sha256=MDiWydumkxQyOGd215g-PRa5FGZgIaO5Hj-35-E5FhI,4908
 cici/providers/gitlab/serializers.py,sha256=heczGlwcmKesugYX8PhwIhVIw8kExsfXKsC52sAwLrc,11533
 cici/providers/gitlab/utils.py,sha256=NUZ25rAosSWQyWh7m3xhiHRotqVl1krckZL58yR0LKQ,651
-cici/providers/gitlab/yaml_style.py,sha256=emgrHqjhMmAWhlgtYJ8NgIYRntSaXQC8T5QDehSbOCM,14101
+cici/providers/gitlab/yaml_style.py,sha256=9Pa_5CUCbWkAp6fWTfWcBBadQzwe4NbK8ETF_IgqY-w,14829
 cici/schema/LICENSE.gitlab,sha256=0N7FHuinuoGBqZE6aUlD84yw3CGylx8lyfzertgmtY0,2001
 cici/schema/__init__.py,sha256=wdYYpZKxK2omc_mRJgPj86Ec-QwoB4noZzlk71sBjnk,87
 cici/schema/gitlab-ci.json,sha256=BCymn2i9JOrUGS2SsvpoXCH8JcofQz9Rhux46zEnS_8,70638
@@ -39,10 +39,10 @@ cici/templates/target-table.md.j2,sha256=NYspLbP3ap1706WnehZRtu6a2uxL_mKf7zfm3y0
 cici/templates/targets.md.j2,sha256=k-lkfReFJMCu9t2SjuD5YJ-Q_KECJxdY7v-0TWDTaCM,116
 cici/templates/variable-list.md.j2,sha256=M9r3j7d8H171okQNj8j4pc92kMdeWSRoeZQ5QB3NUTQ,613
 cici/templates/variables.md.j2,sha256=2DquXagNupqBkD95_3ZI4guJOK-eG_igaaMdRIUDrcE,84
-cici_tools-0.19.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-cici_tools-0.19.1.dist-info/licenses/NOTICE,sha256=dIBr-7sfvnoYXYvgHIozlRJTLD4EHORRtRJtIe4znW8,55
-cici_tools-0.19.1.dist-info/METADATA,sha256=PhyR5NZO2mKiwUqMbL7I-LWgNcDI4m4KGuuoLpgxHn0,4361
-cici_tools-0.19.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-cici_tools-0.19.1.dist-info/entry_points.txt,sha256=CuBAwYG3z7qOKm4IYARjZzdX5fytMLKyr59HLLJx_Is,44
-cici_tools-0.19.1.dist-info/top_level.txt,sha256=sv8xIjFuuqtyBMoyzueczNvZo_--q12r64Zc0lGKKF8,5
-cici_tools-0.19.1.dist-info/RECORD,,
+cici_tools-0.19.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+cici_tools-0.19.2.dist-info/licenses/NOTICE,sha256=dIBr-7sfvnoYXYvgHIozlRJTLD4EHORRtRJtIe4znW8,55
+cici_tools-0.19.2.dist-info/METADATA,sha256=T-fTeUCiST4nLf2OyBTYWWQ3vNRA2Z2UOXkMswXyxzc,4361
+cici_tools-0.19.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cici_tools-0.19.2.dist-info/entry_points.txt,sha256=CuBAwYG3z7qOKm4IYARjZzdX5fytMLKyr59HLLJx_Is,44
+cici_tools-0.19.2.dist-info/top_level.txt,sha256=sv8xIjFuuqtyBMoyzueczNvZo_--q12r64Zc0lGKKF8,5
+cici_tools-0.19.2.dist-info/RECORD,,