From e80ded460fe4c46259ac654c84a0ef7a62962318 Mon Sep 17 00:00:00 2001
From: Michael Hanke <michael.hanke@gmail.com>
Date: Mon, 15 Jan 2024 18:06:28 +0100
Subject: [PATCH] Add `eval_submodule_state` parameter to `iter_gitdiff()`

It is the analog to Git's `--ignore-submodules`. We add that, rather
than a direct equivalent for semantic compatibility with previous
implementations -- although the mapping is rather simple.
---
 datalad_next/iter_collections/gitdiff.py | 31 +++++++++++++++++++++---
 1 file changed, 27 insertions(+), 4 deletions(-)

diff --git a/datalad_next/iter_collections/gitdiff.py b/datalad_next/iter_collections/gitdiff.py
index 54a280a18..0ad31eb5f 100644
--- a/datalad_next/iter_collections/gitdiff.py
+++ b/datalad_next/iter_collections/gitdiff.py
@@ -109,6 +109,8 @@ def iter_gitdiff(
     find_renames: int | None = None,
     find_copies: int | None = None,
     yield_tree_items: str | None = None,
+    # TODO add documentation
+    eval_submodule_state: str = 'commit',
 ) -> Generator[GitDiffItem, None, None]:
     """Report differences between Git tree-ishes or tracked worktree content
 
@@ -200,6 +202,7 @@ def iter_gitdiff(
         find_renames=find_renames,
         find_copies=find_copies,
         yield_tree_items=yield_tree_items,
+        eval_submodule_state=eval_submodule_state,
     )
 
     cmd = _build_cmd(**kwargs)
@@ -249,6 +252,7 @@ def _build_cmd(
     from_treeish, to_treeish,
     recursive, yield_tree_items,
     find_renames, find_copies,
+    eval_submodule_state,
 ) -> list[str]:
     # from   : to   : description
     # ---------------------------
@@ -277,6 +281,16 @@ def _build_cmd(
         # but if that is actually true remains to be tested
         common_args.append(f'--find-copies-harder')
 
+    if eval_submodule_state == 'no':
+        common_args.append('--ignore-submodules=all')
+    elif eval_submodule_state == 'commit':
+        common_args.append('--ignore-submodules=dirty')
+    elif eval_submodule_state == 'full':
+        common_args.append('--ignore-submodules=none')
+    else:
+        raise ValueError(
+            f'unknown submodule evaluation mode {eval_submodule_state!r}')
+
     if from_treeish is None and to_treeish is None:
         raise ValueError(
             'either `from_treeish` or `to_treeish` must not be None')
@@ -343,10 +357,19 @@ def _yield_diff_item(
             yield item
             return
         # this is about a present submodule
-        if item.gitsha is None and item.status == GitDiffStatus.modification:
-            # this modification means that "content" is modified
-            item.add_modification_type(
-                GitContainerModificationType.modified_content)
+        if item.status == GitDiffStatus.modification:
+            if item.gitsha is None:
+                # in 'git diff-index' speak the submodule is "out-of-sync" with
+                # the index: this happens when there are new commits
+                item.add_modification_type(
+                    GitContainerModificationType.new_commits)
+            # TODO we cannot give details for other modification types.
+            # dependening on --ignore-submodules a range of situations
+            # could be the case
+            #else:
+            #    # this modification means that "content" is modified
+            #    item.add_modification_type(
+            #        GitContainerModificationType.modified_content)
         if recursive != 'submodules' or yield_tree_items in (
                 'all', 'submodules'):
             # we are instructed to yield it