Keep metadata out of patch & remove svn patch prefix

Fixes #267

Author: spoorcc

CHANGELOG.rst

@@ -15,6 +15,8 @@ Release 0.11.0 (unreleased)
 * Handle SVN tags with special characters (#811)
 * Don't return non-zero exit code if tool not found during environment (#701)
 * Create standalone binaries for Linux, Mac & Windows (#705)
+* Don't make metadata file part of diff (#267)
+* Fix unneeded project prefix in SVN diffs (#886)
 
 Release 0.10.0 (released 2025-03-12)
 ====================================

dfetch/commands/diff.py

@@ -184,7 +184,9 @@ def _diff_from_repo(repo: VCS, project: ProjectEntry, revs: list[str]) -> str:
     if len(revs) == 1:
         revs.append("")
 
-    return repo.get_diff(*revs)
+    return repo.get_diff(
+        old_revision=revs[0], new_revision=revs[1], ignore=(Metadata.FILENAME,)
+    )
 
 
 def _dump_patch(

dfetch/project/git.py

@@ -2,6 +2,7 @@
 
 import os
 import pathlib
+from collections.abc import Sequence
 from functools import lru_cache
 from typing import Optional
 
@@ -50,9 +51,11 @@ def current_revision(self) -> str:
         """Get the revision of the metadata file."""
         return str(self._local_repo.get_current_hash())
 
-    def get_diff(self, old_revision: str, new_revision: Optional[str]) -> str:
+    def get_diff(
+        self, old_revision: str, new_revision: Optional[str], ignore: Sequence[str]
+    ) -> str:
         """Get the diff of two revisions."""
-        return str(self._local_repo.create_diff(old_revision, new_revision))
+        return str(self._local_repo.create_diff(old_revision, new_revision, ignore))
 
     @staticmethod
     def revision_is_enough() -> bool:

dfetch/project/svn.py

@@ -4,6 +4,7 @@
 import pathlib
 import re
 import urllib.parse
+from collections.abc import Sequence
 from typing import NamedTuple, Optional
 
 from dfetch.log import get_logger
@@ -16,6 +17,7 @@
     in_directory,
     safe_rm,
 )
+from dfetch.vcs.patch import filter_patch
 
 logger = get_logger(__name__)
 
@@ -246,7 +248,7 @@ def _fetch_impl(self, version: Version) -> Version:
         SvnRepo._export(complete_path, rev_arg, self.local_path)
 
         if file_pattern:
-            for file in find_non_matching_files(self.local_path, file_pattern):
+            for file in find_non_matching_files(self.local_path, (file_pattern,)):
                 os.remove(file)
             if not os.listdir(self.local_path):
                 logger.warning(
@@ -366,13 +368,18 @@ def current_revision(self) -> str:
         """Get the current revision of the repo."""
         return self._get_last_changed_revision(self.local_path)
 
-    def get_diff(self, old_revision: str, new_revision: Optional[str]) -> str:
+    def get_diff(
+        self, old_revision: str, new_revision: Optional[str], ignore: Sequence[str]
+    ) -> str:
         """Get the diff between two revisions."""
-        cmd = f"svn diff {self.local_path} -r {old_revision}"
+        cmd = ["svn", "diff", "--non-interactive", ".", "-r", old_revision]
         if new_revision:
-            cmd += f":{new_revision}"
+            cmd[-1] += f":{new_revision}"
 
-        return "\n".join(run_on_cmdline(logger, cmd).stdout.decode().splitlines())
+        with in_directory(self.local_path):
+            patch_text = run_on_cmdline(logger, cmd).stdout
+
+        return filter_patch(patch_text, ignore)
 
     def get_default_branch(self) -> str:
         """Get the default branch of this repository."""

dfetch/project/vcs.py

@@ -365,7 +365,9 @@ def current_revision(self) -> str:
         """Get the revision of the metadata file."""
 
     @abstractmethod
-    def get_diff(self, old_revision: str, new_revision: Optional[str]) -> str:  # noqa
+    def get_diff(
+        self, old_revision: str, new_revision: Optional[str], ignore: Sequence[str]
+    ) -> str:  # noqa
         """Get the diff of two revisions."""
 
     @abstractmethod

dfetch/util/util.py

@@ -21,11 +21,11 @@ def _remove_readonly(func: Any, path: str, _: Any) -> None:
         raise  # pylint: disable=misplaced-bare-raise
 
 
-def find_non_matching_files(directory: str, pattern: str) -> Iterator[str]:
-    """Find files NOT matching the given pattern."""
+def find_non_matching_files(directory: str, patterns: Sequence[str]) -> Iterator[str]:
+    """Find files NOT matching the given patterns."""
     for root, _, files in os.walk(directory):
         for basename in files:
-            if not fnmatch.fnmatch(basename, pattern):
+            if not any(fnmatch.fnmatch(basename, pattern) for pattern in patterns):
                 yield os.path.join(root, basename)
 
 

dfetch/vcs/git.py

@@ -314,7 +314,9 @@ def get_remote_url() -> str:
 
         return decoded_result
 
-    def create_diff(self, old_hash: str, new_hash: Optional[str]) -> str:
+    def create_diff(
+        self, old_hash: str, new_hash: Optional[str], ignore: Sequence[str]
+    ) -> str:
         """Generate a relative diff patch."""
         with in_directory(self._path):
             cmd = [
@@ -328,6 +330,11 @@ def create_diff(self, old_hash: str, new_hash: Optional[str]) -> str:
             ]
             if new_hash:
                 cmd.append(new_hash)
+
+            if ignore:
+                cmd.extend(["--", "."])
+                for ignore_path in ignore:
+                    cmd.append(f":(exclude){ignore_path}")
             result = run_on_cmdline(logger, cmd)
 
         return str(result.stdout.decode())

dfetch/vcs/patch.py

@@ -0,0 +1,37 @@
+"""Various patch utilities for VCS systems."""
+
+from collections.abc import Sequence
+
+import patch_ng
+
+
+def filter_patch(patch_text: bytes, ignore: Sequence[str]) -> str:
+    """Filter out files from a patch text."""
+    if not patch_text:
+        return ""
+
+    filtered_patchset = patch_ng.PatchSet()
+    unfiltered_patchset = patch_ng.fromstring(patch_text) or []
+
+    for patch in unfiltered_patchset:
+        if patch.target.decode("utf-8") not in ignore:
+            filtered_patchset.items += [patch]
+
+    return dump_patch(filtered_patchset)
+
+
+def dump_patch(patch_set: patch_ng.PatchSet) -> str:
+    """Dump a patch to string."""
+    patch_lines: list[str] = []
+    for p in patch_set.items:
+        for headline in p.header:
+            patch_lines.append(headline.rstrip(b"\n").decode("utf-8"))
+        patch_lines.append(f"--- {p.source.decode('utf-8')}")
+        patch_lines.append(f"+++ {p.target.decode('utf-8')}")
+        for h in p.hunks:
+            patch_lines.append(
+                f"@@ -{h.startsrc},{h.linessrc} +{h.starttgt},{h.linestgt} @@"
+            )
+            for line in h.text:
+                patch_lines.append(line.rstrip(b"\n").decode("utf-8"))
+    return "\n".join(patch_lines)

features/diff-in-git.feature

@@ -75,3 +75,12 @@ Feature: Diff in git
             Generated file for SomeProject.git
             +An important sentence for the README!
             """
+
+    Scenario: Metadata is not part of diff
+        Given the metadata file ".dfetch_data.yaml" of "MyProject/SomeProject" is changed
+        When I run "dfetch diff SomeProject"
+        Then the output shows
+        """
+        Dfetch (0.10.0)
+          SomeProject         : No diffs found since 59efb91396fd369eb113b43382783294dc8ed6d2
+        """

features/diff-in-svn.feature

@@ -21,14 +21,14 @@ Feature: Diff in svn
             """
             An important sentence for the README!
             """
-        When I run "dfetch diff SomeProject" in MySvnProject
+        When I run "dfetch -v diff SomeProject" in MySvnProject
         Then the patch file 'MySvnProject/SomeProject.patch' is generated
             """
-            Index: SomeProject/README.md
+            Index: README.md
             ===================================================================
-            --- SomeProject/README.md	(revision 1)
-            +++ SomeProject/README.md	(working copy)
-            @@ -1 +1,2 @@
+            --- README.md
+            +++ README.md
+            @@ -1,1 +1,2 @@
              some content
             +An important sentence for the README!
             """
@@ -43,11 +43,11 @@ Feature: Diff in svn
         When I run "dfetch diff SomeProject" in MySvnProject
         Then the patch file 'MySvnProject/SomeProject.patch' is generated
             """
-            Index: SomeProject/NEWFILE.md
+            Index: NEWFILE.md
             ===================================================================
-            --- SomeProject/NEWFILE.md	(nonexistent)
-            +++ SomeProject/NEWFILE.md	(revision 2)
-            @@ -0,0 +1 @@
+            --- NEWFILE.md
+            +++ NEWFILE.md
+            @@ -0,0 +1,1 @@
             +A completely new untracked file.
             """
 
@@ -67,11 +67,20 @@ Feature: Diff in svn
         When I run "dfetch diff SomeProject" in MySvnProject
         Then the patch file 'MySvnProject/SomeProject.patch' is generated
             """
-            Index: SomeProject/README.md
+            Index: README.md
             ===================================================================
-            --- SomeProject/README.md	(revision 1)
-            +++ SomeProject/README.md	(working copy)
-            @@ -1 +1,2 @@
+            --- README.md
+            +++ README.md
+            @@ -1,1 +1,2 @@
              some content
             +An important sentence for the README!
             """
+
+    Scenario: Metadata is not part of diff
+        Given the metadata file ".dfetch_data.yaml" of "MySvnProject/SomeProject" is changed
+        When I run "dfetch diff SomeProject"
+        Then the output shows
+        """
+        Dfetch (0.10.0)
+          SomeProject         : No diffs found since 1
+        """