support multiline description

Author: mustafasoylu

src/somesy/cff/writer.py

@@ -6,6 +6,7 @@
 
 from cffconvert.cli.create_citation import create_citation
 from ruamel.yaml import YAML
+from ruamel.yaml.scalarstring import LiteralScalarString
 
 from somesy.core.models import Entity, Person, ProjectMetadata
 from somesy.core.writer import FieldKeyMapping, IgnoreKey, ProjectMetadataWriter
@@ -71,6 +72,14 @@ def _validate(self) -> None:
     def save(self, path: Optional[Path] = None) -> None:
         """Save the CFF object to a file."""
         path = path or self.path
+
+        # if description have new line characters, it should be saved as multiline string
+        if "abstract" in self._data:
+            if "\n" in self._data["abstract"]:
+                self._data["abstract"] = LiteralScalarString(self._data["abstract"])
+        else:
+            self._data["abstract"] = str(self.description)
+
         self._yaml.dump(self._data, path)
 
     def _sync_authors(self, metadata: ProjectMetadata) -> None:

src/somesy/fortran/writer.py

@@ -91,6 +91,11 @@ def _validate(self) -> None:
     def save(self, path: Optional[Path] = None) -> None:
         """Save the fpm file."""
         path = path or self.path
+        if "description" in self._data:
+            if "\n" in self._data["description"]:
+                self._data["description"] = tomlkit.string(
+                    self._data["description"], multiline=True
+                )
         with open(path, "w") as f:
             tomlkit.dump(self._data, f)
 

src/somesy/julia/writer.py

@@ -55,6 +55,11 @@ def _validate(self) -> None:
     def save(self, path: Optional[Path] = None) -> None:
         """Save the julia file."""
         path = path or self.path
+        if "description" in self._data:
+            if "\n" in self._data["description"]:
+                self._data["description"] = tomlkit.string(
+                    self._data["description"], multiline=True
+                )
         with open(path, "w") as f:
             tomlkit.dump(self._data, f)
 

src/somesy/mkdocs/writer.py

@@ -6,6 +6,7 @@
 
 from rich.pretty import pretty_repr
 from ruamel.yaml import YAML
+from ruamel.yaml.scalarstring import LiteralScalarString
 
 from somesy.core.models import Entity, Person, ProjectMetadata
 from somesy.core.writer import FieldKeyMapping, IgnoreKey, ProjectMetadataWriter
@@ -67,6 +68,16 @@ def _validate(self) -> None:
     def save(self, path: Optional[Path] = None) -> None:
         """Save the MkDocs object to a file."""
         path = path or self.path
+
+        # if description have new line characters, it should be saved as multiline string
+        if self._data is not None and "site_description" in self._data:
+            if "\n" in self._data["site_description"]:
+                self._data["site_description"] = LiteralScalarString(
+                    self._data["site_description"]
+                )
+            else:
+                self._data["site_description"] = str(self.description)
+
         self._yaml.dump(self._data, path)
 
     @property

src/somesy/pyproject/writer.py

@@ -70,21 +70,8 @@ def save(self, path: Optional[Path] = None) -> None:
                 tomlkit.dump(self._data, f)
             return
 
-        with open(path, "r") as f:
-            # tomlkit formatting sometimes creates empty lines, dont change if context is not changed
-            existing_data = f.read()
-
-            # remove empty lines
-            existing_data = existing_data.replace("\n", "")
-
-            new_data = tomlkit.dumps(self._data)
-            new_data = new_data.replace("\n", "")
-
-        if existing_data != new_data:
-            with open(path, "w") as f:
-                tomlkit.dump(self._data, f)
-        else:
-            logger.debug("No changes to pyproject.toml file")
+        with open(path, "w") as f:
+            tomlkit.dump(self._data, f)
 
     def _get_property(
         self, key: Union[str, List[str]], *, remove: bool = False, **kwargs
@@ -235,39 +222,11 @@ def sync(self, metadata: ProjectMetadata) -> None:
 
         # For Poetry v2, convert authors and maintainers from array of tables to inline tables
         if self._poetry_version == 2:
-            # if license field has text, or file, make it inline table of tomlkit
-            if self._get_property(["license"]) is not None:
-                license_value = self._get_property(["license"])
-                # Create and populate inline table
-                inline_table = tomlkit.inline_table()
-                if isinstance(license_value, str):
-                    inline_table["text"] = license_value
-                elif isinstance(license_value, dict):
-                    if "text" in license_value:
-                        inline_table["text"] = license_value["text"]
-                    elif "file" in license_value:
-                        inline_table["file"] = license_value["file"]
-                elif hasattr(license_value, "text"):
-                    inline_table["text"] = license_value.text
-                elif hasattr(license_value, "file"):
-                    inline_table["file"] = license_value.file
-
-                # Create a new table with the same structure
-                table = tomlkit.table()
-                table.add("license", inline_table)
-                if "license" in self._data["project"]:
-                    # Copy the whitespace/formatting from the existing table
-                    table.trivia.indent = self._data["project"]["license"].trivia.indent
-                    table.trivia.comment_ws = self._data["project"][
-                        "license"
-                    ].trivia.comment_ws
-                    table.trivia.comment = self._data["project"][
-                        "license"
-                    ].trivia.comment
-                    table.trivia.trail = self._data["project"]["license"].trivia.trail
-
-                self._data["project"]["license"] = table["license"]
-
+            if "description" in self._data["project"]:
+                if "\n" in self._data["project"]["description"]:
+                    self._data["project"]["description"] = tomlkit.string(
+                        self._data["project"]["description"], multiline=True
+                    )
             # Move urls section to the end if it exists
             if "urls" in self._data["project"]:
                 urls = self._data["project"].pop("urls")

src/somesy/rust/writer.py

@@ -5,7 +5,7 @@
 from typing import Any, List, Optional, Union
 
 from rich.pretty import pretty_repr
-from tomlkit import dump, load, table
+from tomlkit import dump, load, string, table
 
 from somesy.core.models import Entity, Person, ProjectMetadata
 from somesy.core.writer import FieldKeyMapping, IgnoreKey, ProjectMetadataWriter
@@ -60,6 +60,13 @@ def _validate(self) -> None:
     def save(self, path: Optional[Path] = None) -> None:
         """Save the Cargo.toml file."""
         path = path or self.path
+
+        if "description" in self._data["package"]:
+            if "\n" in self._data["package"]["description"]:
+                self._data["package"]["description"] = string(
+                    self._data["package"]["description"], multiline=True
+                )
+
         with open(path, "w") as f:
             dump(self._data, f)