👌 IMPROVE: Use gitpython (#2)

Author: chrisjsewell

README.md

@@ -70,6 +70,7 @@ Options:
   -q, --quiet                     Remove stdout logging.
   -v, --verbose                   Increase stdout logging.
   --exit-code INTEGER             Exit code when files changed.  [default: 2]
+  --no-git                        Do not add new files to a git index.
   --test-run                      Do not delete/create any files.
   --config FILE                   Read default configuration from a file
                                   (allowed extensions: .json, .toml, .yml,
@@ -199,13 +200,13 @@ To run the tests:
 
 ```console
 pip install tox
-tox
+tox -e py37
 ```
 
 To test out the CLI:
 
 ```console
-tox -e py37-cli -- --help
+tox -e py37-cli
 ```
 
 For code style:

scss_compile/__init__.py

@@ -4,18 +4,18 @@
 import hashlib
 import os
 from pathlib import Path
-from subprocess import check_call
 import sys
-from typing import Set
+from typing import Optional, Set
 
 import click
 import click_config_file
+from git import Repo, InvalidGitRepositoryError
 import sass
 import toml
 import yaml
 
 
-def config_provider(file_path, cmd_name):
+def config_provider(file_path: str, cmd_name: str):
     """Read configuration file."""
     _, ext = os.path.splitext(file_path)
     text = Path(file_path).read_text()
@@ -101,11 +101,9 @@ def config_provider(file_path, cmd_name):
     help="Exit code when files changed.",
 )
 @click.option(
-    "--git-add/--no-git-add",
-    default=True,
+    "--no-git",
     is_flag=True,
-    show_default=True,
-    help="Attempt to add new files to the git index (required by pre-commit).",
+    help="Do not add new files to a git index.",
 )
 @click.option("--test-run", is_flag=True, help="Do not delete/create any files.")
 @click_config_file.configuration_option(
@@ -130,14 +128,26 @@ def run_compile(
     quiet,
     verbose,
     exit_code,
-    git_add,
+    no_git,
     test_run,
 ):
     """Compile all SCSS files in the paths provided.
 
     For directories; include all non-partial SCSS files, and
     for files; if partial, include all adjacent, non-partial, SCSS files.
     """
+
+    if no_git:
+        git_repo = None
+    else:
+        try:
+            # TODO allow for the cwd to be in a child directory of the repo
+            git_repo = Repo(os.getcwd(), search_parent_directories=False)
+        except InvalidGitRepositoryError:
+            raise click.ClickException(
+                f"CWD is not the root of a git repository (use --no-git): {os.getcwd()}"
+            )
+
     try:
         translate = (
             {}
@@ -157,6 +167,8 @@ def run_compile(
                     "translate": translate,
                     "sourcemap": sourcemap,
                     "precision": precision,
+                    "git": git_repo.git_dir if git_repo else None,
+                    "exit_code": exit_code,
                 }
             }
         )
@@ -251,13 +263,14 @@ def run_compile(
             css_out_path = out_dir / (out_name + ".css")
         if not test_run:
 
-            if update_file(css_out_path, css_str, encoding, git_add):
+            if update_file(css_out_path, css_str, encoding, git_repo, verbose):
                 changed_files = True
             if sourcemap and update_file(
                 out_dir / (scss_path.name + ".map.json"),
                 sourcemap_str,
                 encoding,
-                git_add,
+                git_repo,
+                verbose,
             ):
                 changed_files = True
 
@@ -283,13 +296,17 @@ def run_compile(
         sys.exit(exit_code)
 
 
-def update_file(path, text, encoding, git_add) -> bool:
+def update_file(
+    path: Path, text: str, encoding: str, git_repo: Optional[Repo], verbose: bool
+) -> bool:
 
     if not path.exists():
         path.write_text(text, encoding=encoding)
-        if git_add:
-            # this is required, to ensure creations are picked up by pre-commit
-            check_call(["git", "add", str(path)])
+        if git_repo is not None:
+            # this is required, to ensure file creations are picked up by pre-commit
+            git_repo.index.add([str(path)], write=True)
+            if verbose:
+                click.echo(f"Added to git index: {str(path)}")
         return True
 
     if text != path.read_text(encoding=encoding):

setup.py

@@ -28,6 +28,7 @@
         "click~=7.1.2",
         "click-config-file~=0.6.0",
         "libsass~=0.20.1",
+        "gitpython~=3.1.8",
         "pyyaml",
         "toml",
     ],

tests/test_run_compile.py

@@ -1,17 +1,25 @@
+import os
 from pathlib import Path
 import shutil
 
 from click.testing import CliRunner
+from git import Repo
 import pytest
 
 from scss_compile import run_compile
 
 
 @pytest.fixture()
-def scss_folder(tmp_path):
+def scss_folder(tmp_path: Path) -> Path:
+    """Copy the scss folder to a temporary folder, and initialise it as git repo."""
     src = tmp_path / "scss"
     shutil.copytree(Path(__file__).parent / "example_scss", src)
+    repo = Repo.init(str(tmp_path))
+    repo.index.commit("initial commit")
+    original_cwd = os.getcwd()
+    os.chdir(tmp_path)
     yield src
+    os.chdir(original_cwd)
     shutil.rmtree(tmp_path)
 
 
@@ -20,25 +28,22 @@ def test_help():
     assert result.exit_code == 0, result.output
 
 
-def test_file(scss_folder):
-    result = CliRunner().invoke(
-        run_compile, ["--no-git-add", str(scss_folder / "example1.scss")]
-    )
+def test_file(scss_folder: Path):
+    result = CliRunner().invoke(run_compile, [str(scss_folder / "example1.scss"), "-v"])
     assert result.exit_code == 2, result.output
     assert (scss_folder / "example1.css").exists(), result.output
+    assert len(Repo(scss_folder.parent).index.diff("HEAD")) == 1
 
     # should not change any files
-    result = CliRunner().invoke(
-        run_compile, ["--no-git-add", str(scss_folder / "example1.scss")]
-    )
+    result = CliRunner().invoke(run_compile, [str(scss_folder / "example1.scss")])
     assert result.exit_code == 0, result.output
     assert (scss_folder / "example1.css").exists(), result.output
 
 
-def test_file_hash(scss_folder):
+def test_file_hash(scss_folder: Path):
     result = CliRunner().invoke(
         run_compile,
-        ["--no-git-add", str(scss_folder / "example1.scss"), "--hash-filenames"],
+        [str(scss_folder / "example1.scss"), "--hash-filenames"],
     )
     assert result.exit_code == 2, result.output
     assert len(list(scss_folder.glob("example1#*.css"))) == 1, result.output
@@ -47,33 +52,32 @@ def test_file_hash(scss_folder):
     # should create same hash
     result = CliRunner().invoke(
         run_compile,
-        ["--no-git-add", str(scss_folder / "example1.scss"), "--hash-filenames"],
+        [str(scss_folder / "example1.scss"), "--hash-filenames"],
     )
     assert result.exit_code == 0, result.output
     assert len(list(scss_folder.glob("example1#*.css"))) == 1, result.output
     assert path.exists(), result.output
 
 
-def test_file_sourcemap(scss_folder):
+def test_file_sourcemap(scss_folder: Path):
     result = CliRunner().invoke(
-        run_compile, ["--no-git-add", str(scss_folder / "example1.scss"), "--sourcemap"]
+        run_compile, [str(scss_folder / "example1.scss"), "--sourcemap"]
     )
     assert result.exit_code == 2, result.output
     assert (scss_folder / "example1.css").exists(), result.output
     assert (scss_folder / "example1.scss.map.json").exists(), result.output
 
 
-def test_partials(scss_folder):
+def test_partials(scss_folder: Path):
     result = CliRunner().invoke(
-        run_compile, ["--no-git-add", str(scss_folder / "partials" / "_example1.scss")]
+        run_compile, [str(scss_folder / "partials" / "_example1.scss")]
     )
     assert result.exit_code == 0, result.output
     assert not (scss_folder / "example1.css").exists(), result.output
 
     result = CliRunner().invoke(
         run_compile,
         [
-            "--no-git-add",
             str(scss_folder / "partials" / "_example1.scss"),
             "--partial-depth=1",
         ],
@@ -82,18 +86,18 @@ def test_partials(scss_folder):
     assert (scss_folder / "example1.css").exists(), result.output
 
 
-def test_folder(scss_folder):
-    result = CliRunner().invoke(run_compile, ["--no-git-add", str(scss_folder)])
+def test_folder(scss_folder: Path):
+    result = CliRunner().invoke(run_compile, [str(scss_folder)])
     assert result.exit_code == 2, result.output
     assert (scss_folder / "example1.css").exists(), result.output
     assert (scss_folder / "example2.css").exists(), result.output
+    assert len(Repo(scss_folder.parent).index.diff("HEAD")) == 2
 
 
-def test_translate(scss_folder):
+def test_translate(scss_folder: Path):
     result = CliRunner().invoke(
         run_compile,
         [
-            "--no-git-add",
             str(scss_folder / "example1.scss"),
             "--translate",
             str(scss_folder) + ":" + str(scss_folder.parent / "css"),

tox.ini

@@ -18,7 +18,7 @@ extras = testing
 commands = pytest {posargs}
 
 [testenv:py{36,37,38}-cli]
-commands = scss-compile {posargs}
+commands = scss-compile {posargs:tests/ -v --config=scss-compile-config.yml}
 
 [testenv:try-repo]
 deps = pre-commit