gitacross 2.3.2__tar.gz → 2.4.0__tar.gz

{gitacross-2.3.2/src/gitacross.egg-info → gitacross-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitacross
-Version: 2.3.2
+Version: 2.4.0
 Summary: Mirror releases and git commits across platforms (Gitea, GitHub, local) with transform pipelines.
 Author: Matthew Deik
 License-Expression: MIT
@@ -390,17 +390,22 @@ In `regex` mode, backreferences (e.g. `\1`) are expanded before the casing adapt
 | Field | Required | Description |
 |---|---|---|
 | `path` | yes | File path to create (parent dirs auto-created) |
-| `content` | yes | File contents |
+| `content` | one of | Inline file contents. Takes precedence over `src` when both are given |
+| `src` | one of | Path of an existing **regular file** to copy in — binary-safe, mode & timestamps preserved (relative to where you run gitacross) |
+
+Provide inline `content` or point `src` at an existing file (`content` wins if both are set — use `content: ""` for an empty file). Inline `content` is written as UTF-8 text with `\n` line endings on every OS. `src` copies the file in with `shutil.copy2` — no decode/encode round-trip and no newline translation — so binary assets work and the result is byte-identical on any platform. `src` must point to a single file, not a directory.
 
 ```yaml
 - add:
     - path: .github/FUNDING.yml
       content: |
         github: myuser
-    - path: RELEASE_NOTES.md
-      content: |
-        # Release Notes
-        ...
+    - path: LICENSE
+      src: ../templates/LICENSE   # copy an existing file instead of inlining it
+    - path: assets/favicon.ico
+      src: ../../branding/favicon.ico   # binary files work too
+    - path: tools/deploy.sh
+      src: ./scripts/deploy.sh    # executable bit is preserved (copy2)
 ```
 
 #### `validate`

{gitacross-2.3.2 → gitacross-2.4.0}/README.md

@@ -361,17 +361,22 @@ In `regex` mode, backreferences (e.g. `\1`) are expanded before the casing adapt
 | Field | Required | Description |
 |---|---|---|
 | `path` | yes | File path to create (parent dirs auto-created) |
-| `content` | yes | File contents |
+| `content` | one of | Inline file contents. Takes precedence over `src` when both are given |
+| `src` | one of | Path of an existing **regular file** to copy in — binary-safe, mode & timestamps preserved (relative to where you run gitacross) |
+
+Provide inline `content` or point `src` at an existing file (`content` wins if both are set — use `content: ""` for an empty file). Inline `content` is written as UTF-8 text with `\n` line endings on every OS. `src` copies the file in with `shutil.copy2` — no decode/encode round-trip and no newline translation — so binary assets work and the result is byte-identical on any platform. `src` must point to a single file, not a directory.
 
 ```yaml
 - add:
     - path: .github/FUNDING.yml
       content: |
         github: myuser
-    - path: RELEASE_NOTES.md
-      content: |
-        # Release Notes
-        ...
+    - path: LICENSE
+      src: ../templates/LICENSE   # copy an existing file instead of inlining it
+    - path: assets/favicon.ico
+      src: ../../branding/favicon.ico   # binary files work too
+    - path: tools/deploy.sh
+      src: ./scripts/deploy.sh    # executable bit is preserved (copy2)
 ```
 
 #### `validate`

{gitacross-2.3.2 → gitacross-2.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitacross"
-version = "2.3.2"
+version = "2.4.0"
 description = "Mirror releases and git commits across platforms (Gitea, GitHub, local) with transform pipelines."
 readme = "README.md"
 requires-python = ">=3.8"

{gitacross-2.3.2 → gitacross-2.4.0}/src/gitacross/linter/fixer.py

@@ -244,6 +244,16 @@ class ConfigFixer:
                                         "Removed redundant 'case_sensitive: true' in validate operation",
                                         project_name=p_name,
                                     )
+                                if (
+                                    op_type == "add"
+                                    and item.get("content") is not None
+                                    and item.get("src")
+                                ):
+                                    del item["src"]
+                                    self._add(
+                                        "Removed redundant 'src' in add operation ('content' takes precedence)",
+                                        project_name=p_name,
+                                    )
 
 
 

{gitacross-2.3.2 → gitacross-2.4.0}/src/gitacross/linter/validator.py

@@ -693,14 +693,41 @@ class ConfigLinter:
 
                 elif op_type == "add":
                     for item in items:
-                        if (
-                            not isinstance(item, dict)
-                            or not item.get("path")
-                            or "content" not in item
+                        if not isinstance(item, dict):
+                            self._add(
+                                LintSeverity.ERROR,
+                                "Add operation item requires 'path' and either 'content' or 'src'.",
+                                project_name=p_name,
+                            )
+                            continue
+                        if not item.get("path") or (
+                            item.get("content") is None and not item.get("src")
+                        ):
+                            self._add(
+                                LintSeverity.ERROR,
+                                "Add operation item requires 'path' and either 'content' or 'src'.",
+                                project_name=p_name,
+                            )
+                        if item.get("content") is not None and not isinstance(
+                            item["content"], str
                         ):
                             self._add(
                                 LintSeverity.ERROR,
-                                "Add operation item requires 'path' and 'content'.",
+                                "Add option 'content' must be a string.",
+                                project_name=p_name,
+                            )
+                        if item.get("src") is not None and not isinstance(
+                            item["src"], str
+                        ):
+                            self._add(
+                                LintSeverity.ERROR,
+                                "Add option 'src' must be a string path to an existing file.",
+                                project_name=p_name,
+                            )
+                        if item.get("content") is not None and item.get("src"):
+                            self._add(
+                                LintSeverity.REDUNDANT,
+                                "'src' is ignored when 'content' is present in add operation.",
                                 project_name=p_name,
                             )
 

{gitacross-2.3.2 → gitacross-2.4.0}/src/gitacross/renderer.py

@@ -196,9 +196,17 @@ def _match_case(matched, replacement):
 def _op_add(work, ops):
     """Create files in the work tree before commit.
 
-    Each op: {path: str, content: str}
-    Raises if the path already exists (avoids silently overwriting).
-    Creates parent directories automatically.
+    Each op: {path: str, content?: str, src?: str}
+    - content: inline file contents — takes precedence over ``src`` when both
+      are given (even an empty string). Written as UTF-8 text with ``\n`` line
+      endings on every OS.
+    - src: path of an existing regular file to copy in — binary-safe (no
+      decode/encode round-trip) via :func:`shutil.copy2`, so the bytes as well
+      as the mode/timestamps are preserved. Directories are rejected; relative
+      paths resolve against the current working directory.
+    If neither is given the file is created empty. Raises if the path already
+    exists (avoids silently overwriting). Creates parent directories
+    automatically.
     """
     for op in ops:
         path = op["path"]
@@ -206,10 +214,37 @@ def _op_add(work, ops):
         if target.exists():
             raise RuntimeError(f"Add conflict: '{path}' already exists")
         target.parent.mkdir(parents=True, exist_ok=True)
-        target.write_text(op.get("content", ""), encoding="utf-8")
+        content = op.get("content")
+        if content is not None:
+            _write_text_lf(target, content)
+        else:
+            src = op.get("src")
+            if not src:
+                _write_text_lf(target, "")
+            else:
+                source = Path(src)
+                if not source.is_file():
+                    if source.exists():
+                        raise RuntimeError(
+                            f"Add failed: 'src' '{src}' is not a file (path: '{path}') — only regular files can be added"
+                        )
+                    raise RuntimeError(
+                        f"Add failed: source file '{src}' not found for '{path}'"
+                    )
+                _ = shutil.copy2(source, target)
         logger.debug("Added file: %s", path)
 
 
+def _write_text_lf(path, text):
+    """Write *text* as UTF-8 with ``\n`` endings regardless of the host OS.
+
+    Text mode on Windows would otherwise translate ``\n`` to ``\r\n``
+    (``os.linesep``), making inline content depend on where gitacross runs.
+    """
+    with open(path, "w", encoding="utf-8", newline="\n") as f:
+        _ = f.write(text)
+
+
 def _op_validate(work, ops):
     """Assert conditions on the final tree. Aborts on failure.
 

{gitacross-2.3.2 → gitacross-2.4.0/src/gitacross.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitacross
-Version: 2.3.2
+Version: 2.4.0
 Summary: Mirror releases and git commits across platforms (Gitea, GitHub, local) with transform pipelines.
 Author: Matthew Deik
 License-Expression: MIT
@@ -390,17 +390,22 @@ In `regex` mode, backreferences (e.g. `\1`) are expanded before the casing adapt
 | Field | Required | Description |
 |---|---|---|
 | `path` | yes | File path to create (parent dirs auto-created) |
-| `content` | yes | File contents |
+| `content` | one of | Inline file contents. Takes precedence over `src` when both are given |
+| `src` | one of | Path of an existing **regular file** to copy in — binary-safe, mode & timestamps preserved (relative to where you run gitacross) |
+
+Provide inline `content` or point `src` at an existing file (`content` wins if both are set — use `content: ""` for an empty file). Inline `content` is written as UTF-8 text with `\n` line endings on every OS. `src` copies the file in with `shutil.copy2` — no decode/encode round-trip and no newline translation — so binary assets work and the result is byte-identical on any platform. `src` must point to a single file, not a directory.
 
 ```yaml
 - add:
     - path: .github/FUNDING.yml
       content: |
         github: myuser
-    - path: RELEASE_NOTES.md
-      content: |
-        # Release Notes
-        ...
+    - path: LICENSE
+      src: ../templates/LICENSE   # copy an existing file instead of inlining it
+    - path: assets/favicon.ico
+      src: ../../branding/favicon.ico   # binary files work too
+    - path: tools/deploy.sh
+      src: ./scripts/deploy.sh    # executable bit is preserved (copy2)
 ```
 
 #### `validate`

{gitacross-2.3.2 → gitacross-2.4.0}/tests/test_linter.py

@@ -859,6 +859,9 @@ def test_linter_operations_kitchen_sink():
       - replace: [search, replace]
       - replace: [{search: a, replace: b, pattern: banana}]
       - add: [{}]
+      - add: [{path: no-body}]
+      - add: [{path: n, content: 123}]
+      - add: [{path: n, src: 123}]
       - validate: [not-a-dict]
 """)
     assert not report.is_valid
@@ -871,10 +874,35 @@ def test_linter_operations_kitchen_sink():
     assert "Rename pattern mode 'glob' is not supported" in msgs
     assert "Replace operation item requires 'search' and 'replace'" in msgs
     assert "Invalid replace pattern mode 'banana'" in msgs
-    assert "Add operation item requires 'path' and 'content'" in msgs
+    assert "Add operation item requires 'path' and either 'content' or 'src'" in msgs
+    assert "Add option 'content' must be a string" in msgs
+    assert "Add option 'src' must be a string path" in msgs
     assert "Validate operation item requires 'path'" in msgs
     print("  ✓ linter: operation kitchen-sink validation")
 
+
+def test_linter_add_src_and_precedence():
+    """add accepts 'content' or 'src'; both together is redundant, not an error."""
+    from gitacross.linter import ConfigLinter
+
+    linter = ConfigLinter()
+    report = linter.lint_yaml_string("""
+- name: p
+  source: {type: local, path: /a}
+  target: {type: local, path: /b}
+  renderer:
+    operations:
+      - add: [{path: a.txt, content: hi}]
+      - add: [{path: b.txt, src: tmpl.txt}]
+      - add: [{path: c.txt, content: hi, src: tmpl.txt}]
+      - add: [{path: d.txt, content: ""}]
+""")
+    assert report.is_valid  # redundant 'src' + no type errors
+    red = " | ".join(r.message for r in report.redundant)
+    assert "'src' is ignored when 'content' is present" in red
+    assert len(report.errors) == 0
+    print("  ✓ linter: add accepts content or src (content wins when both given)")
+
 def test_fix_report_and_issue_formatting():
     """FixIssue strings and FixReport.format_text variants."""
     from gitacross.linter import FixIssue, FixReport
@@ -1029,3 +1057,43 @@ def test_fixer_missing_endpoint_sections():
     ).is_valid
     print("  ✓ fixer: missing endpoint sections and junk operations handled")
 
+
+def test_fixer_add_drops_src_shadowed_by_content():
+    """'src' is dead weight next to 'content' — --fix removes it, keeps src alone."""
+    import yaml
+
+    from gitacross.linter import ConfigFixer
+
+    fixer = ConfigFixer()
+    r = fixer.fix_yaml_string(
+        "- name: p\n"
+        + "  source: {type: local, path: /a}\n"
+        + "  target: {type: local, path: /b}\n"
+        + "  renderer:\n"
+        + "    operations:\n"
+        + "      - add:\n"
+        + "          - path: a.txt\n"
+        + "            content: hi\n"
+        + "            src: tmpl.txt\n"
+        + "          - path: b.txt\n"
+        + "            src: tmpl.txt\n"
+    )
+    assert r.is_valid
+    assert any("'src' in add operation" in f.message for f in r.fixes)
+    adds = yaml.safe_load(r.content)[0]["renderer"]["operations"][0]["add"]
+    assert "src" not in adds[0]
+    assert adds[0]["content"] == "hi"
+    assert adds[1]["src"] == "tmpl.txt"  # src alone is untouched
+
+    # content: null does NOT shadow src → src kept
+    r = fixer.fix_yaml_string(
+        "- name: p\n"
+        + "  source: {type: local, path: /a}\n"
+        + "  target: {type: local, path: /b}\n"
+        + "  renderer:\n"
+        + "    operations:\n"
+        + "      - add: [{path: a.txt, content: null, src: tmpl.txt}]\n"
+    )
+    assert r.is_valid and not r.fixes
+    print("  ✓ fixer: add op drops 'src' shadowed by 'content'")
+

{gitacross-2.3.2 → gitacross-2.4.0}/tests/test_renderer.py

@@ -431,6 +431,95 @@ def test_renderer_add():
     print("  ✓ renderer add")
 
 
+def test_renderer_add_from_src():
+    """add can copy an existing file via 'src'; inline 'content' wins over it."""
+    from gitacross.config import ProjectConfig
+    from gitacross.renderer import apply_operations
+
+    with tempfile.TemporaryDirectory() as tmp:
+        root = Path(tmp)
+        # Source template lives *outside* the exported work tree (as in real
+        # runs — the work tree is an ephemeral export, so 'src' resolves
+        # against the process working directory).
+        template = Path(tmp) / "FUNDING.tmpl"
+        _ = template.write_text("github: myuser\n", encoding="utf-8")
+        _ = _make_file(root, "README.md")
+
+        ops = [
+            {
+                "add": [
+                    {"path": ".github/FUNDING.yml", "src": str(template)},
+                    # content wins, even an empty string
+                    {"path": "inline.txt", "content": "inline", "src": str(template)},
+                    {"path": "empty.txt", "content": "", "src": str(template)},
+                ]
+            }
+        ]
+        project = ProjectConfig(_make_project_raw(ops))
+        apply_operations(root, project)
+
+        assert (root / ".github/FUNDING.yml").read_text() == "github: myuser\n"
+        assert (root / "inline.txt").read_text() == "inline"
+        assert (root / "empty.txt").read_text() == ""
+
+        # Missing source file -> loud error naming both paths
+        ops = [{"add": [{"path": "x.txt", "src": str(root / "nope.txt")}]}]
+        project = ProjectConfig(_make_project_raw(ops))
+        try:
+            apply_operations(root, project)
+            assert False, "should raise"
+        except RuntimeError as e:
+            assert "source file" in str(e) and "x.txt" in str(e)
+
+        # Directory as src -> explicit rejection, not a confusing copy
+        (root / "adir").mkdir()
+        ops = [{"add": [{"path": "y.txt", "src": str(root / "adir")}]}]
+        project = ProjectConfig(_make_project_raw(ops))
+        try:
+            apply_operations(root, project)
+            assert False, "should raise"
+        except RuntimeError as e:
+            assert "is not a file" in str(e) and "y.txt" in str(e)
+
+    print("  ✓ renderer add from src file")
+
+
+def test_renderer_add_src_binary():
+    """src copies non-UTF-8/binary files byte-for-byte; copy2 keeps the mode."""
+    from gitacross.config import ProjectConfig
+    from gitacross.renderer import apply_operations
+
+    with tempfile.TemporaryDirectory() as tmp:
+        root = Path(tmp)
+        # Every byte value 0..255 (invalid UTF-8) + NULs + no trailing newline
+        payload = bytes(range(256)) * 3 + b"\x00\xfftail"
+        asset = root / "logo.bin"
+        _ = asset.write_bytes(payload)
+        _ = _make_file(root, "README.md")
+        if os.name != "nt":  # exec bit is a POSIX concept
+            os.chmod(asset, 0o755)
+
+        ops = [{"add": [{"path": "assets/deep/logo.bin", "src": str(asset)}]}]
+        project = ProjectConfig(_make_project_raw(ops))
+        apply_operations(root, project)
+
+        copied = root / "assets/deep/logo.bin"
+        assert copied.exists()
+        assert copied.read_bytes() == payload  # exact byte identity
+        assert asset.read_bytes() == payload  # source untouched
+        assert (root / "README.md").exists()
+        if os.name != "nt":
+            assert os.stat(copied).st_mode & 0o777 == 0o755  # mode preserved
+
+        # empty add item (no content/src) still creates an empty file
+        ops = [{"add": [{"path": "bare.txt"}]}]
+        project = ProjectConfig(_make_project_raw(ops))
+        apply_operations(root, project)
+        assert (root / "bare.txt").read_bytes() == b""
+
+    print("  ✓ renderer add copies binary src byte-for-byte (mode preserved)")
+
+
 def test_renderer_validate_fail():
     from gitacross.config import ProjectConfig
     from gitacross.renderer import apply_operations