From 731ace6f661ab15718513dc11a3de27ceb79da03 Mon Sep 17 00:00:00 2001
From: Hussein Faara <faarahussein@gmail.com>
Date: Thu, 21 Dec 2023 22:40:52 -0800
Subject: [PATCH 01/10] Read exclude patterns from .gitignore in absence of
 user-provided patterns (#344)

Use .gitignore to exclude files if --exclude is missing from both
pyproject.toml and the command line. Vulture now requires the
pathspec library to run.
---
 CHANGELOG.md                     |  1 +
 README.md                        |  4 +++
 setup.py                         |  5 ++-
 tests/test_gitignore_patterns.py | 56 ++++++++++++++++++++++++++++++++
 vulture/core.py                  | 17 +++++++++-
 5 files changed, 81 insertions(+), 2 deletions(-)
 create mode 100644 tests/test_gitignore_patterns.py

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d9ec6de8..aa4bc07e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,7 @@
 * Bump flake8, flake8-comprehensions and flake8-bugbear (Sebastian Csar, #341).
 * Switch to tomllib/tomli to support heterogeneous arrays (Sebastian Csar, #340).
 * Provide whitelist parity for `MagicMock` and `Mock` (maxrake).
+* Use .gitignore to exclude files if --exclude is missing from both pyproject.toml and the command line.
 
 # 2.10 (2023-10-06)
 
diff --git a/README.md b/README.md
index 99b2ec81..981d9ef8 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,10 @@ If you want to ignore a whole file or directory, use the `--exclude` parameter
 (e.g., `--exclude "*settings.py,*/docs/*.py,*/test_*.py,*/.venv/*.py"`). The
 exclude patterns are matched against absolute paths.
 
+Note that releases after 2.10 will parse the project's .gitignore files for
+exclude patterns if the `--exclude` parameter is unused and if there are no
+exclude patterns in the pyproject.toml file.
+
 #### Flake8 noqa comments
 
 <!-- Hide noqa docs until we decide whether we want to support it.
diff --git a/setup.py b/setup.py
index 48549415..8a049726 100644
--- a/setup.py
+++ b/setup.py
@@ -47,7 +47,10 @@ def find_version(*parts):
         "Programming Language :: Python :: Implementation :: PyPy",
         "Topic :: Software Development :: Quality Assurance",
     ],
-    install_requires=["tomli >= 1.1.0; python_version < '3.11'"],
+    install_requires=[
+        "tomli >= 1.1.0; python_version < '3.11'",
+        "pathspec >= 0.12.1",
+    ],
     entry_points={"console_scripts": ["vulture = vulture.core:main"]},
     python_requires=">=3.8",
     packages=setuptools.find_packages(exclude=["tests"]),
diff --git a/tests/test_gitignore_patterns.py b/tests/test_gitignore_patterns.py
new file mode 100644
index 00000000..0a07adef
--- /dev/null
+++ b/tests/test_gitignore_patterns.py
@@ -0,0 +1,56 @@
+import os
+import pathlib
+import pytest
+import shutil
+
+from . import call_vulture
+from vulture.utils import ExitCode
+
+
+class TempGitignore:
+    def __init__(self, patterns):
+        self.patterns = patterns
+        root = pathlib.Path(".").resolve()
+        self.file = root / ".gitignore"
+        self.tmpfile = root / ".tmp_gitignore"
+
+    def __enter__(self):
+        shutil.move(self.file, self.tmpfile)
+        with open(self.file, "w") as f:
+            f.write("\n".join(self.patterns))
+
+        return self.file
+
+    def __exit__(self, *args):
+        os.remove(self.file)
+        shutil.move(self.tmpfile, self.file)
+
+
+@pytest.fixture(scope="function")
+def gitignore(request):
+    with TempGitignore(request.param) as fpath:
+        yield fpath
+
+
+@pytest.mark.parametrize(
+    "exclude_patterns,gitignore,exit_code",
+    (
+        ([], [], ExitCode.NoDeadCode),
+        ([""], [], ExitCode.NoDeadCode),
+        ([], [""], ExitCode.NoDeadCode),
+        ([""], ["core.py", "utils.py"], ExitCode.NoDeadCode),
+        (["core.py", "utils.py"], [""], ExitCode.DeadCode),
+        ([], ["core.py", "utils.py"], ExitCode.DeadCode),
+    ),
+    indirect=("gitignore",),
+)
+def test_gitignore(exclude_patterns, gitignore, exit_code):
+    def get_csv(paths):
+        return ",".join(os.path.join("vulture", path) for path in paths)
+
+    cli_args = ["vulture/"]
+    if exclude_patterns:
+        cli_args.extend(["--exclude", get_csv(exclude_patterns)])
+
+    assert gitignore.is_file()
+    assert call_vulture(cli_args) == exit_code
diff --git a/vulture/core.py b/vulture/core.py
index b3c845cd..b0f4e64a 100644
--- a/vulture/core.py
+++ b/vulture/core.py
@@ -1,6 +1,7 @@
 import ast
 from fnmatch import fnmatch, fnmatchcase
 from pathlib import Path
+from pathspec import PathSpec
 import pkgutil
 import re
 import string
@@ -114,6 +115,13 @@ def _ignore_variable(filename, varname):
     )
 
 
+def _get_gitignore_pathspec():
+    if (gitignore := Path(".gitignore").resolve()).is_file:
+        with gitignore.open() as fh:
+            return PathSpec.from_lines("gitwildmatch", fh)
+    return PathSpec.from_lines("gitwildmatch", [])
+
+
 class Item:
     """
     Hold the name, type and location of defined code.
@@ -263,9 +271,16 @@ def prepare_pattern(pattern):
             return pattern
 
         exclude = [prepare_pattern(pattern) for pattern in (exclude or [])]
+        gitignore = _get_gitignore_pathspec()
 
         def exclude_path(path):
-            return _match(path, exclude, case=False)
+            # if no exclude patterns are provided through the cli arguments or
+            # a toml file, use .gitignore patterns to inform exclusion
+            return (
+                _match(path, exclude, case=False)
+                if exclude
+                else gitignore.match_file(path)
+            )
 
         paths = [Path(path) for path in paths]
 

From ccfa37e8b073da8b9c22c53522bdc3afd2a95a09 Mon Sep 17 00:00:00 2001
From: Hussein Faara <faarahussein@gmail.com>
Date: Fri, 22 Dec 2023 19:57:51 -0800
Subject: [PATCH 02/10] review suggestions

---
 README.md       | 2 +-
 setup.py        | 2 +-
 vulture/core.py | 6 +++---
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 981d9ef8..e531d8ef 100644
--- a/README.md
+++ b/README.md
@@ -83,7 +83,7 @@ If you want to ignore a whole file or directory, use the `--exclude` parameter
 (e.g., `--exclude "*settings.py,*/docs/*.py,*/test_*.py,*/.venv/*.py"`). The
 exclude patterns are matched against absolute paths.
 
-Note that releases after 2.10 will parse the project's .gitignore files for
+Vulture 2.11+ parses the `.gitignore` file in the current working directory for
 exclude patterns if the `--exclude` parameter is unused and if there are no
 exclude patterns in the pyproject.toml file.
 
diff --git a/setup.py b/setup.py
index 8a049726..bee1df02 100644
--- a/setup.py
+++ b/setup.py
@@ -49,7 +49,7 @@ def find_version(*parts):
     ],
     install_requires=[
         "tomli >= 1.1.0; python_version < '3.11'",
-        "pathspec >= 0.12.1",
+        "pathspec >= 0.12.1; python_version >= '3.8'",
     ],
     entry_points={"console_scripts": ["vulture = vulture.core:main"]},
     python_requires=">=3.8",
diff --git a/vulture/core.py b/vulture/core.py
index b0f4e64a..b118aab3 100644
--- a/vulture/core.py
+++ b/vulture/core.py
@@ -1,12 +1,12 @@
 import ast
 from fnmatch import fnmatch, fnmatchcase
 from pathlib import Path
-from pathspec import PathSpec
 import pkgutil
 import re
 import string
 import sys
 
+from pathspec import PathSpec
 from vulture import lines
 from vulture import noqa
 from vulture import utils
@@ -274,8 +274,8 @@ def prepare_pattern(pattern):
         gitignore = _get_gitignore_pathspec()
 
         def exclude_path(path):
-            # if no exclude patterns are provided through the cli arguments or
-            # a toml file, use .gitignore patterns to inform exclusion
+            # If no exclude patterns are provided via the CLI or
+            # a TOML file, use .gitignore patterns to inform exclusion.
             return (
                 _match(path, exclude, case=False)
                 if exclude

From e38be50ab4cec24463dd44bde89be3b72aa1438f Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 16:39:19 +0100
Subject: [PATCH 03/10] CI: build and install wheels of dependencies.

---
 .github/workflows/main.yml | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 301e24e5..82d9cf53 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -32,11 +32,11 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install --upgrade build coveralls setuptools tox wheel
 
-    - name: Build Vulture wheel
-      run: python -m build
+    - name: Build wheels for Vulture and its dependencies
+      run: python -m pip wheel .
 
-    - name: Install Vulture wheel
-      run: "python -m pip install --only-binary=:all: --ignore-installed --find-links=dist/ vulture"
+    - name: Install wheels
+      run: python -m pip install *.whl
 
     - name: Run Vulture
       run: |

From d825526d177997c2c6f0e83ce3ab59bf03e7307d Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 16:44:42 +0100
Subject: [PATCH 04/10] Update CHANGELOG.md

---
 CHANGELOG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index aa4bc07e..28b0693b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,7 +2,7 @@
 * Bump flake8, flake8-comprehensions and flake8-bugbear (Sebastian Csar, #341).
 * Switch to tomllib/tomli to support heterogeneous arrays (Sebastian Csar, #340).
 * Provide whitelist parity for `MagicMock` and `Mock` (maxrake).
-* Use .gitignore to exclude files if --exclude is missing from both pyproject.toml and the command line.
+* Use .gitignore to exclude files if --exclude is missing from both pyproject.toml and the command line (whosayn, #344, #345).
 
 # 2.10 (2023-10-06)
 

From 5df1161de0efd8df5d2605dac844f6d4646891cc Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 16:45:37 +0100
Subject: [PATCH 05/10] Update setup.py

---
 setup.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index bee1df02..8a049726 100644
--- a/setup.py
+++ b/setup.py
@@ -49,7 +49,7 @@ def find_version(*parts):
     ],
     install_requires=[
         "tomli >= 1.1.0; python_version < '3.11'",
-        "pathspec >= 0.12.1; python_version >= '3.8'",
+        "pathspec >= 0.12.1",
     ],
     entry_points={"console_scripts": ["vulture = vulture.core:main"]},
     python_requires=">=3.8",

From b22c52cb4d3799fe14ca6612ab4fa6b9db98b61b Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 16:51:44 +0100
Subject: [PATCH 06/10] Fix install command on Windows.

---
 .github/workflows/main.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 82d9cf53..75120384 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -36,7 +36,7 @@ jobs:
       run: python -m pip wheel .
 
     - name: Install wheels
-      run: python -m pip install *.whl
+      run: python -m pip install *
 
     - name: Run Vulture
       run: |

From 73707561ae48d722371b5707397ed7756950b900 Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 17:07:39 +0100
Subject: [PATCH 07/10] Fix install command on Windows.

---
 .github/workflows/main.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 75120384..aed762eb 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -36,7 +36,7 @@ jobs:
       run: python -m pip wheel .
 
     - name: Install wheels
-      run: python -m pip install *
+      run: "python -m pip install *.whl"
 
     - name: Run Vulture
       run: |

From 463d610ea1f4903117661e8fad4e720e78a261fd Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 17:11:19 +0100
Subject: [PATCH 08/10] Fix install command on Windows.

---
 .github/workflows/main.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index aed762eb..2e21647f 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -36,7 +36,7 @@ jobs:
       run: python -m pip wheel .
 
     - name: Install wheels
-      run: "python -m pip install *.whl"
+      run: python -m pip install --find-links=. *
 
     - name: Run Vulture
       run: |

From d825587ff33a057f11d4f4e2f941957ea31adf97 Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 17:12:40 +0100
Subject: [PATCH 09/10] Fix install command on Windows.

---
 .github/workflows/main.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 2e21647f..103b9ba3 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -36,7 +36,7 @@ jobs:
       run: python -m pip wheel .
 
     - name: Install wheels
-      run: python -m pip install --find-links=. *
+      run: python -m pip install --find-links=. *.whl
 
     - name: Run Vulture
       run: |

From 361e0cbcee1c1bf74ff076193be0f638d864bf29 Mon Sep 17 00:00:00 2001
From: Jendrik Seipp <jendrikseipp@gmail.com>
Date: Sat, 23 Dec 2023 17:23:20 +0100
Subject: [PATCH 10/10] Fix install command on Windows.

---
 .github/workflows/main.yml | 9 +++++----
 requirements.txt           | 2 ++
 setup.py                   | 8 ++++----
 3 files changed, 11 insertions(+), 8 deletions(-)
 create mode 100644 requirements.txt

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 103b9ba3..676614d3 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -31,12 +31,13 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install --upgrade build coveralls setuptools tox wheel
+        python -m pip install -r requirements.txt
 
-    - name: Build wheels for Vulture and its dependencies
-      run: python -m pip wheel .
+    - name: Build Vulture wheel
+      run: python -m build
 
-    - name: Install wheels
-      run: python -m pip install --find-links=. *.whl
+    - name: Install Vulture wheel
+      run: "python -m pip install --only-binary=:all: --ignore-installed --find-links=dist/ vulture"
 
     - name: Run Vulture
       run: |
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 00000000..32d83476
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+pathspec >= 0.12.1
+tomli >= 1.1.0; python_version < '3.11'
diff --git a/setup.py b/setup.py
index 8a049726..d9187eac 100644
--- a/setup.py
+++ b/setup.py
@@ -20,6 +20,9 @@ def find_version(*parts):
 with open("README.md") as f1, open("CHANGELOG.md") as f2:
     long_description = f1.read() + "\n\n" + f2.read()
 
+with open("requirements.txt") as f:
+    install_requires = f.read().splitlines()
+
 setuptools.setup(
     name="vulture",
     version=find_version("vulture", "version.py"),
@@ -47,10 +50,7 @@ def find_version(*parts):
         "Programming Language :: Python :: Implementation :: PyPy",
         "Topic :: Software Development :: Quality Assurance",
     ],
-    install_requires=[
-        "tomli >= 1.1.0; python_version < '3.11'",
-        "pathspec >= 0.12.1",
-    ],
+    install_requires=install_requires,
     entry_points={"console_scripts": ["vulture = vulture.core:main"]},
     python_requires=">=3.8",
     packages=setuptools.find_packages(exclude=["tests"]),