start implementing pom.xml support, refactor out lots of code duplication

Author: a.pirogov

poetry.lock

@@ -44,6 +44,7 @@ cffconvert = "^2.0.0"
 wrapt = "^1.15.0"
 packaging = "^23.1"
 jinja2 = "^3.1.2"
+defusedxml = "^0.7.1"
 
 [tool.poetry.group.dev.dependencies]
 poethepoet = "^0.18.1"

pyproject.toml

@@ -6,7 +6,12 @@
 import typer
 from jinja2 import Environment, FunctionLoader, select_autoescape
 
-from .util import resolved_somesy_input, wrap_exceptions
+from .util import (
+    existing_file_arg_config,
+    file_arg_config,
+    resolved_somesy_input,
+    wrap_exceptions,
+)
 
 logger = logging.getLogger("somesy")
 app = typer.Typer()
@@ -19,37 +24,22 @@ def fill(
         None,
         "--template",
         "-t",
-        exists=True,
-        file_okay=True,
-        dir_okay=False,
-        writable=False,
-        readable=True,
-        resolve_path=False,
         help="Path to a Jinja2 template for somesy to fill (default: stdin).",
+        **existing_file_arg_config,
     ),
     input_file: Path = typer.Option(
         None,
         "--input-file",
         "-i",
-        exists=True,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
         help="Path of somesy input file (default: try to infer).",
+        **existing_file_arg_config,
     ),
     output_file: Path = typer.Option(
         None,
         "--output-file",
         "-o",
-        exists=False,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=False,
-        resolve_path=True,
         help="Path for target file (default: stdout).",
+        **file_arg_config,
     ),
 ):
     """Fill a Jinja2 template with somesy project metadata (e.g. list authors in project docs)."""

src/somesy/cli/fill.py

@@ -23,46 +23,56 @@ def config():
 
     # prompt for inputs
     input_file = typer.prompt("Input file path", default=input_file_default)
-    input_file = Path(input_file)
-    options = {
-        "input_file": input_file,
-        "no_sync_cff": not typer.confirm(
-            "Do you want to sync to a CFF file?", default=True
-        ),
-    }
-    cff_file = typer.prompt("CFF file path", default="CITATION.cff")
-    if cff_file is not None or cff_file != "":
+    options = dict(input_file=Path(input_file))
+
+    # ----
+
+    options["no_sync_cff"] = not typer.confirm(
+        "Do you want to sync to a CFF file?", default=True
+    )
+    if cff_file := typer.prompt("CFF file path", default="CITATION.cff"):
         options["cff_file"] = cff_file
 
+    options["no_sync_codemeta"] = not typer.confirm(
+        "Do you want to sync to a codemeta.json file?", default=True
+    )
+    if codemeta_file := typer.prompt(
+        "codemeta.json file path", default="codemeta.json"
+    ):
+        options["codemeta_file"] = codemeta_file
+
     options["no_sync_pyproject"] = not typer.confirm(
         "Do you want to sync to a pyproject.toml file?", default=True
     )
-
-    pyproject_file = typer.prompt("pyproject.toml file path", default="pyproject.toml")
-    if pyproject_file is not None or pyproject_file != "":
+    if pyproject_file := typer.prompt(
+        "pyproject.toml file path", default="pyproject.toml"
+    ):
         options["pyproject_file"] = pyproject_file
 
     options["sync_package_json"] = typer.confirm(
         "Do you want to sync to a package.json file?", default=False
     )
-    package_json_file = typer.prompt("package.json file path", default="package.json")
-    if package_json_file is not None or package_json_file != "":
+    if package_json_file := typer.prompt(
+        "package.json file path", default="package.json"
+    ):
         options["package_json_file"] = package_json_file
 
-    options["no_sync_codemeta"] = not typer.confirm(
-        "Do you want to sync to a codemeta.json file?", default=True
-    )
-    codemeta_file = typer.prompt("codemeta.json file path", default="codemeta.json")
-    if codemeta_file is not None or codemeta_file != "":
-        options["codemeta_file"] = codemeta_file
-
     options["no_sync_julia"] = not typer.confirm(
         "Do you want to sync to a Project.toml(Julia) file?", default=True
     )
-    julia_file = typer.prompt("Project.toml(Julia) file path", default="Project.toml")
-    if julia_file is not None or julia_file != "":
+    if julia_file := typer.prompt(
+        "Project.toml (Julia) file path", default="Project.toml"
+    ):
         options["julia_file"] = julia_file
 
+    options["no_sync_pom_xml"] = not typer.confirm(
+        "Do you want to sync to a pom.xml file?", default=True
+    )
+    if pom_xml_file := typer.prompt("pom.xml file path", default="pom.xml"):
+        options["pom_xml_file"] = pom_xml_file
+
+    # ----
+
     options["show_info"] = typer.confirm(
         "Do you want to show info about the sync process?"
     )

src/somesy/cli/init.py

@@ -7,7 +7,12 @@
 from somesy.commands import sync as sync_command
 from somesy.core.models import SomesyInput
 
-from .util import resolved_somesy_input, wrap_exceptions
+from .util import (
+    existing_file_arg_config,
+    file_arg_config,
+    resolved_somesy_input,
+    wrap_exceptions,
+)
 
 logger = logging.getLogger("somesy")
 
@@ -21,13 +26,8 @@ def sync(
         None,
         "--input-file",
         "-i",
-        exists=False,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
         help="Somesy input file path (default: .somesy.toml)",
+        **file_arg_config,
     ),
     no_sync_pyproject: bool = typer.Option(
         None,
@@ -39,13 +39,8 @@ def sync(
         None,
         "--pyproject-file",
         "-p",
-        exists=True,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
         help="Existing pyproject.toml file path (default: pyproject.toml)",
+        **existing_file_arg_config,
     ),
     no_sync_package_json: bool = typer.Option(
         None,
@@ -57,13 +52,34 @@ def sync(
         None,
         "--package-json-file",
         "-j",
-        exists=True,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
         help="Existing package.json file path (default: package.json)",
+        **existing_file_arg_config,
+    ),
+    no_sync_julia: bool = typer.Option(
+        None,
+        "--no-sync-julia",
+        "-L",
+        help="Do not sync Project.toml (Julia) file (default: False)",
+    ),
+    julia_file: Path = typer.Option(
+        None,
+        "--julia-file",
+        "-l",
+        help="Custom Project.toml (Julia) file path (default: Project.toml)",
+        **existing_file_arg_config,
+    ),
+    no_sync_pom_xml: bool = typer.Option(
+        None,
+        "--no-sync-pomxml",
+        "-X",
+        help="Do not sync pom.xml (Java Maven) file (default: False)",
+    ),
+    pom_xml_file: Path = typer.Option(
+        None,
+        "--pomxml-file",
+        "-x",
+        help="Custom pom.xml (Java Maven) file path (default: pom.xml)",
+        **existing_file_arg_config,
     ),
     no_sync_cff: bool = typer.Option(
         None,
@@ -75,49 +91,21 @@ def sync(
         None,
         "--cff-file",
         "-c",
-        exists=False,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
         help="CITATION.cff file path (default: CITATION.cff)",
+        **file_arg_config,
     ),
     no_sync_codemeta: bool = typer.Option(
         None,
         "--no-sync-codemeta",
         "-M",
-        help="Do not sync codemeta.json file",
+        help="Do not sync codemeta.json file (default: False)",
     ),
     codemeta_file: Path = typer.Option(
         None,
         "--codemeta-file",
         "-m",
-        exists=False,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
-        help="Custom codemeta.json file path",
-    ),
-    no_sync_julia: bool = typer.Option(
-        None,
-        "--no-sync-julia",
-        "-M",
-        help="Do not sync Project.toml(Julia) file",
-    ),
-    julia_file: Path = typer.Option(
-        None,
-        "--julia-file",
-        "-m",
-        exists=True,
-        file_okay=True,
-        dir_okay=False,
-        writable=True,
-        readable=True,
-        resolve_path=True,
-        help="Custom Project.toml(Julia) file path",
+        help="Custom codemeta.json file path (default: codemeta.json)",
+        **file_arg_config,
     ),
 ):
     """Sync project metadata input with metadata files."""
@@ -133,6 +121,8 @@ def sync(
         codemeta_file=codemeta_file,
         no_sync_julia=no_sync_julia,
         julia_file=julia_file,
+        no_sync_pom_xml=no_sync_pom_xml,
+        pom_xml_file=pom_xml_file,
     )
     run_sync(somesy_input)
 
@@ -150,6 +140,14 @@ def run_sync(somesy_input: SomesyInput):
         logger.info(
             f"  - [italic]package.json[/italic]:\t[grey]{conf.package_json_file}[/grey]"
         )
+    if not conf.no_sync_julia:
+        logger.info(
+            f"  - [italic]Project.toml[/italic]:\t[grey]{conf.julia_file}[/grey]\n"
+        )
+    if not conf.no_sync_pom_xml:
+        logger.info(
+            f"  - [italic]pom.xml[/italic]:\t[grey]{conf.pom_xml_file}[/grey]\n"
+        )
     if not conf.no_sync_cff:
         logger.info(f"  - [italic]CITATION.cff[/italic]:\t[grey]{conf.cff_file}[/grey]")
     if not conf.no_sync_codemeta:

src/somesy/cli/sync.py

@@ -14,6 +14,18 @@
 logger = logging.getLogger("somesy")
 
 
+# configuration dicts for CLI file arguments
+file_arg_config = dict(
+    file_okay=True,
+    dir_okay=False,
+    writable=True,
+    readable=True,
+    resolve_path=True,
+)
+existing_file_arg_config = dict(file_arg_config)
+existing_file_arg_config.update(dict(exists=True))
+
+
 @wrapt.decorator
 def wrap_exceptions(wrapped, instance, args, kwargs):
     """Format and log exceptions for cli commands."""

src/somesy/cli/util.py

@@ -1,4 +1,4 @@
 """Integration with codemeta.json (to re-generate codemeta as part of somesy sync)."""
-from .writer import Codemeta
+from .writer import CodeMeta
 
-__all__ = ["Codemeta"]
+__all__ = ["CodeMeta"]

src/somesy/codemeta/__init__.py

@@ -13,7 +13,7 @@
 logger = logging.getLogger("somesy")
 
 
-class Codemeta(ProjectMetadataWriter):
+class CodeMeta(ProjectMetadataWriter):
     """Codemeta.json parser and saver."""
 
     def __init__(
@@ -71,7 +71,7 @@ def _validate(self) -> None:
         config = dict(self._get_property([]))
 
         logger.debug(
-            f"No validation for codemeta.json files {Codemeta.__name__}: {pretty_repr(config)}"
+            f"No validation for codemeta.json files {CodeMeta.__name__}: {pretty_repr(config)}"
         )
 
     def _init_new_file(self) -> None: