Merge pull request #188 from packit/sections

Ignore sections in macro definitions

Fixes #184.

Reviewed-by: Jiri Popelka <None>

Author: softwarefactory-project-zuul[bot]

specfile/macro_definitions.py

@@ -67,7 +67,7 @@ def get_raw_data(self) -> List[str]:
         result = self._preceding_lines.copy()
         ws = self._whitespace
         macro = "%global" if self.is_global else "%define"
-        body = self.body.replace("\n", "\\\n").splitlines()
+        body = self.body.splitlines()
         if body:
             body[-1] += ws[3]
         else:
@@ -198,6 +198,36 @@ def parse(cls, lines: List[str]) -> "MacroDefinitions":
         Returns:
             Constructed instance of `MacroDefinitions` class.
         """
+
+        def count_brackets(s):
+            bc = pc = 0
+            chars = list(s)
+            while chars:
+                c = chars.pop(0)
+                if c == "\\" and chars:
+                    chars.pop(0)
+                    continue
+                if c == "%" and chars:
+                    c = chars.pop(0)
+                    if c == "{":
+                        bc += 1
+                    elif c == "(":
+                        pc += 1
+                    continue
+                if c == "{" and bc > 0:
+                    bc += 1
+                    continue
+                if c == "}" and bc > 0:
+                    bc -= 1
+                    continue
+                if c == "(" and pc > 0:
+                    pc += 1
+                    continue
+                if c == ")" and pc > 0:
+                    pc -= 1
+                    continue
+            return bc, pc
+
         md_regex = re.compile(
             r"""
             ^
@@ -215,21 +245,26 @@ def parse(cls, lines: List[str]) -> "MacroDefinitions":
         )
         data = []
         buffer: List[str] = []
+        lines = lines.copy()
         while lines:
             line = lines.pop(0)
             m = md_regex.match(line)
             if m:
                 ws0, macro, ws1, name, ws2, body, ws3 = m.groups()
                 if ws3 == "\\":
-                    while line.endswith("\\") and lines:
-                        line = lines.pop(0)
-                        body += "\n" + line.rstrip("\\")
-                    tokens = re.split(r"(\s+)$", body, maxsplit=1)
-                    if len(tokens) == 1:
-                        body = tokens[0]
-                        ws3 = ""
-                    else:
-                        body, ws3, _ = tokens
+                    body += ws3
+                    ws3 = ""
+                bc, pc = count_brackets(body)
+                while (bc > 0 or pc > 0 or body.endswith("\\")) and lines:
+                    line = lines.pop(0)
+                    body += "\n" + line
+                    bc, pc = count_brackets(body)
+                tokens = re.split(r"(\s+)$", body, maxsplit=1)
+                if len(tokens) == 1:
+                    body = tokens[0]
+                else:
+                    body, ws, _ = tokens
+                    ws3 = ws + ws3
                 data.append(
                     MacroDefinition(
                         name, body, macro == "%global", (ws0, ws1, ws2, ws3), buffer

specfile/sections.py

@@ -13,6 +13,7 @@
     SIMPLE_SCRIPT_SECTIONS,
 )
 from specfile.formatter import formatted
+from specfile.macro_definitions import MacroDefinitions
 from specfile.macros import Macros
 from specfile.options import Options
 
@@ -258,12 +259,20 @@ def split_id(line):
                 return name, options, delimiter, separator, content
             return tokens[0], None, "", separator, content
 
+        excluded_lines = []
+        macro_definitions = MacroDefinitions.parse(lines)
+        for md in macro_definitions:
+            position = md.get_position(macro_definitions)
+            excluded_lines.append(range(position, position + len(md.get_raw_data())))
         section_id_regexes = [
-            re.compile(rf"^%{re.escape(n)}(\s+.*$|$)", re.IGNORECASE)
+            re.compile(rf"^%{re.escape(n)}(\s+.*(?<!\\)$|$)", re.IGNORECASE)
             for n in SECTION_NAMES
         ]
         section_starts = []
         for i, line in enumerate(lines):
+            # section can not start inside macro definition body
+            if any(i in r for r in excluded_lines):
+                continue
             if line.startswith("%"):
                 for r in section_id_regexes:
                     if r.match(line):

tests/unit/test_macro_definitions.py

@@ -64,17 +64,27 @@ def test_parse():
             "",
             "%define desc(x) Test spec file containing several \\",
             "macro definitions in various formats (%?1)",
+            "",
+            "%define example() %{expand:",
+            "This an example of a macro definition with body ",
+            "spawning across mutiple lines}",
         ]
     )
     assert macro_definitions[0].name == "gitdate"
     assert macro_definitions[1].name == "commit"
     assert macro_definitions.commit.body == "9ab9717cf7d1be1a85b165a8eacb71b9e5831113"
     assert macro_definitions[2].name == "shortcommit"
-    assert macro_definitions[-1].name == "desc(x)"
-    assert macro_definitions[-1].body == (
-        "Test spec file containing several \n"
+    assert macro_definitions[3].name == "desc(x)"
+    assert macro_definitions[3].body == (
+        "Test spec file containing several \\\n"
         "macro definitions in various formats (%?1)"
     )
+    assert macro_definitions[-1].name == "example()"
+    assert macro_definitions[-1].body == (
+        "%{expand:\n"
+        "This an example of a macro definition with body \n"
+        "spawning across mutiple lines}"
+    )
 
 
 def test_get_raw_data():
@@ -92,7 +102,7 @@ def test_get_raw_data():
             ),
             MacroDefinition(
                 "desc(x)",
-                "Test spec file containing several \nmacro definitions in various formats (%?1)",
+                "Test spec file containing several \\\nmacro definitions in various formats (%?1)",
                 False,
                 ("", " ", " ", ""),
                 [
@@ -102,6 +112,15 @@ def test_get_raw_data():
                     "",
                 ],
             ),
+            MacroDefinition(
+                "example()",
+                "%{expand:\n"
+                "This an example of a macro definition with body \n"
+                "spawning across mutiple lines}",
+                False,
+                ("", " ", " ", ""),
+                [""],
+            ),
         ]
     )
     assert macro_definitions.get_raw_data() == [
@@ -114,6 +133,10 @@ def test_get_raw_data():
         "",
         "%define desc(x) Test spec file containing several \\",
         "macro definitions in various formats (%?1)",
+        "",
+        "%define example() %{expand:",
+        "This an example of a macro definition with body ",
+        "spawning across mutiple lines}",
     ]
 
 

tests/unit/test_sections.py

@@ -103,6 +103,34 @@ def test_parse_invalid_name():
     assert sections.description[2] == "%description(fr)"
 
 
+def test_parse_macro_definitions():
+    sections = Sections.parse(
+        [
+            "%package -n test",
+            "Summary: Subpackage test",
+            "",
+            "%description -n test",
+            "Subpackage test.",
+            "",
+            "%define template1()\\",
+            "%package -n %{1}\\",
+            "Summary: Subpackage %{1}\\",
+            "\\",
+            "%description -n %{1}\\",
+            "Subpackage %{1}.",
+            "",
+            "%define template2() %{expand:",
+            "%package -n %{1}",
+            "Summary: Subpackage %{1}",
+            "",
+            "%description -n %{1}",
+            "Subpackage %{1}.}",
+        ]
+    )
+    assert len(sections) == 3
+    assert sections[1].id == "package -n test"
+
+
 def test_get_raw_data():
     sections = Sections(
         [