Show versions diff of modules

Author: SanmerDev

Diff for: sync/cli/Main.py

@@ -253,6 +253,16 @@ def sync(cls) -> int:
         index = Index(root_folder=root_folder, config=config)
         index(version=cls._args.index_version, to_file=True)
 
+        if cls._args.diff_file:
+            markdown_text = sync.get_versions_diff()
+            if markdown_text is not None:
+                if isinstance(cls._args.diff_file, str):
+                    diff_file = Path(cls._args.diff_file)
+                    diff_file.write_text(markdown_text)
+
+                else:
+                    print(markdown_text)
+
         if cls._args.push:
             sync.push_by_git(cls._args.git_branch)
 

Diff for: sync/cli/Parameters.py

@@ -2,6 +2,7 @@
 from argparse import (
     ArgumentParser as ArgumentParserBase,
     RawDescriptionHelpFormatter,
+    Action,
     _HelpAction
 )
 from pathlib import Path
@@ -33,6 +34,14 @@ def __init__(self, *args, **kwargs):
             Parameters.add_parser_help(self)
 
 
+class BoolOrStrAction(Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        if values is None or values == "" or values.isspace():
+            values = True
+
+        setattr(namespace, self.dest, values)
+
+
 class Parameters:
     _root_folder: Path
     _github_token: Optional[str]
@@ -293,6 +302,14 @@ def configure_parser_sync(cls, sub_parsers):
             default=Index.latest_version,
             help="Version of the index file ({0}), default: {1}.".format(ModulesJson.filename(), "%(default)s")
         )
+        p.add_argument(
+            "--diff",
+            dest="diff_file",
+            metavar="FILE",
+            action=BoolOrStrAction,
+            nargs="?",
+            help="Save versions diff of modules (GitHub flavored Markdown)."
+        )
         p.add_argument(
             "--force",
             action="store_true",

Diff for: sync/core/Sync.py

@@ -3,6 +3,8 @@
 from concurrent.futures import ThreadPoolExecutor
 from datetime import datetime
 
+from tabulate import tabulate
+
 from .Config import Config
 from .Pull import Pull
 from ..model import (
@@ -29,6 +31,8 @@ def __init__(self, root_folder, config, tracks=None):
         else:
             self._tracks = tracks
 
+        self._updated_diff = list()
+
     def _update_jsons(self, track, force):
         module_folder = self._modules_folder.joinpath(track.id)
 
@@ -88,6 +92,15 @@ def _update_jsons(self, track, force):
         update_json.write(update_json_file)
         track.write(track_json_file)
 
+        if len(update_json.versions) >= 2:
+            self._updated_diff.append(
+                (update_json.versions[-2], online_module)
+            )
+        else:
+            self._updated_diff.append(
+                (None, online_module)
+            )
+
         return online_module
 
     @staticmethod
@@ -153,3 +166,22 @@ def push_by_git(self, branch):
         subprocess.run(["git", "add", "."], cwd=self._root_folder.as_posix())
         subprocess.run(["git", "commit", "-m", msg], cwd=self._root_folder.as_posix())
         subprocess.run(["git", "push", "-u", "origin", branch], cwd=self._root_folder.as_posix())
+
+    def get_versions_diff(self):
+        headers = ["id", "name", "version"]
+        table = []
+
+        if len(self._updated_diff) == 0:
+            return None
+
+        for last, new in self._updated_diff:
+            version = new.version_display
+            if last is not None:
+                version = f"{last.version_display} -> {version}"
+
+            table.append(
+                [new.id, new.name, version]
+            )
+
+        markdown_text = tabulate(table, headers, tablefmt="github")
+        return markdown_text

Diff for: sync/core/Sync.pyi

@@ -1,12 +1,13 @@
 from datetime import date
 from pathlib import Path
-from typing import Optional, List
+from typing import Optional, List, Tuple
 
 from .Pull import Pull
 from ..model import (
     ConfigJson,
     TrackJson,
-    OnlineModule
+    OnlineModule,
+    VersionItem
 )
 from ..track import BaseTracks
 from ..utils import Log
@@ -21,6 +22,7 @@ class Sync:
     _modules_folder: Path
     _config: ConfigJson
     _tracks: BaseTracks
+    _updated_diff: List[Tuple[Optional[VersionItem], OnlineModule]]
 
     def  __init__(self, root_folder: Path, config: ConfigJson, tracks: Optional[BaseTracks] = ...): ...
     def _update_jsons(self, track: TrackJson, force: bool) -> Optional[OnlineModule]: ...
@@ -30,3 +32,4 @@ class Sync:
     def create_local_tracks(self) -> BaseTracks: ...
     def update(self, module_ids: Optional[List[str]] = ..., force: bool = ..., **kwargs): ...
     def push_by_git(self, branch: str): ...
+    def get_versions_diff(self) -> Optional[str]: ...