build: merge v3.0.1 to main

Author: efa2d19

.github/dependabot.yml

@@ -16,3 +16,10 @@ updates:
     commit-message:
       prefix: "poetry"
     target-branch: "develop"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      time: "12:00"
+      day: "friday"

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md renamed to .github/pull_request_template.md

@@ -7,7 +7,6 @@ on:
       - develop
 
   pull_request:
-    # The branches below must be a subset of the branches above
     branches:
       - main
       - develop

.github/workflows/codeql.yml

@@ -7,14 +7,13 @@ on:
       - develop
 
   pull_request:
-    # The branches below must be a subset of the branches above
     branches:
       - main
       - develop
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
     strategy:
       matrix:
         python-version: [ '3.10', '3.11' ]

.github/workflows/tox.yml

@@ -3,7 +3,7 @@ default_stages:
 
 repos:
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v2.42.1
+    rev: v3.0.1
     hooks:
       - id: commitizen
         name: Check Convenient Commits
@@ -23,14 +23,6 @@ repos:
         name: Run isort
         types: [ python ]
 
-  - repo: https://github.com/PyCQA/docformatter
-    rev: v1.5.1
-    hooks:
-      - id: docformatter
-        name: Run docformatter
-        types: [ python ]
-        args: [ --config=./pyproject.toml]
-
   - repo: local
     hooks:
       - id: pytest
@@ -53,3 +45,10 @@ repos:
         pass_filenames: false
         types: [ python ]
         entry: poetry run ruff check .
+
+      - id: docformatter
+        name: Run docformatter
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        entry: poetry run docformatter -cr . --config ./pyproject.toml

.pre-commit-config.yaml

@@ -106,7 +106,7 @@ $ mac-cleanup -h
 usage: mac-cleanup [-h] [-n] [-u] [-c] [-p]
 
     A Mac Cleanup Utility in Python
-    3.0.0
+    3.0.1
     https://github.com/mac-cleanup/mac-cleanup-py    
 
 options:

README.md

@@ -4,11 +4,11 @@
 
 Any version with :x: are no longer supported and may face issues in it.
 
-| Version | Supported          |
-|---------| ------------------ |
-| 3.0.0   | :white_check_mark: |
-| < 3.0   | :x:                |
+| Version   | Supported          |
+|-----------|--------------------|
+| \>= 3.0.0 | :white_check_mark: |
+| < 3.0.0   | :x:                |
 
 ## Reporting a Vulnerability
 
-To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/mac-cleanup/mac-cleanup-py/security/advisories/new) tab.
+To report a security issue, please use [GitHub Issues](https://github.com/Drugsosos/mac-cleanup-py/issues/new/choose).

SECURITY.md

@@ -204,7 +204,7 @@ def _count_dry(self) -> float:
         from mac_cleanup.progress import ProgressBar
 
         # Extract all modules
-        all_modules = list(chain(*[unit.modules for unit in self._execute_list]))
+        all_modules = list(chain.from_iterable([unit.modules for unit in self._execute_list]))
 
         # Filter modules based on Path
         path_modules: list[Path] = list(filter(partial(self.__filter_modules, filter_type=Path), all_modules))

mac_cleanup/core.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mac_cleanup"
-version = "3.0.0"
+version = "3.0.1"
 description = "Python cleanup script for macOS"
 license = "Apache-2.0"
 authors = [ "Drugsosos" ]
@@ -31,7 +31,7 @@ exclude = [ "mac_cleanup/__main__.py", "mac_cleanup/py.typed" ]
 [tool.poetry.dependencies]
 python = ">=3.10,<3.12"
 rich = "^13.3.4"
-attrs = "^22.2.0"
+attrs = "^23.1.0"
 inquirer = "^3.1.3"
 toml = "^0.10.2"
 beartype = "^0.13.1"
@@ -40,29 +40,20 @@ beartype = "^0.13.1"
 mac-cleanup = "mac_cleanup:main"
 
 [tool.poetry.group.test.dependencies]
-tox = "^4.4.11"
-pytest = "^7.3.0"
+tox = "^4.5.0"
+pytest = "^7.3.1"
 pytest-cov = "^4.0.0"
-pyright = "^1.1.302"
-ruff = "^0.0.261"
-flake8-bugbear = "^23.3.23"
-flake8-comprehensions = "^3.12.0"
-flake8-print = "^5.0.0"
-flake8-quotes = "^3.3.2"
-flake8-builtins = "^2.1.0"
-flake8-pytest-style = "^1.7.2"
-flake8-blind-except = "^0.2.1"
-flake8-no-pep420 = "^2.3.0"
-flake8-simplify = "^0.20.0"
+pyright = "^1.1.304"
+ruff = "^0.0.263"
 
 [tool.poetry.group.dev.dependencies]
-commitizen = "^2.42.1"
+commitizen = "^3.0.1"
 pre-commit = "^3.2.2"
 
 [tool.poetry.group.lint.dependencies]
 black = "^23.3.0"
 isort = "^5.12.0"
-docformatter = "1.5.1"
+docformatter = "^1.6.3"
 
 [build-system]
 requires = [ "poetry-core>=1.0.0" ]
@@ -135,12 +126,11 @@ select = [
     "SIM",  # simplify
 ]
 
-
 [tool.ruff.flake8-quotes]
 inline-quotes = "double"
 multiline-quotes = "double"
 
 [tool.pytest.ini_options]
-minversion = "7.2.2"
+minversion = "7.3.1"
 addopts = "--cov=mac_cleanup"
 testpaths = [ "tests" ]

poetry.lock

@@ -2,13 +2,6 @@
 from _pytest.monkeypatch import MonkeyPatch
 
 
-@pytest.fixture(scope="session", autouse=False)
-def get_current_os() -> str:
-    import platform
-
-    return platform.system()
-
-
 @pytest.fixture()
 def _command_with_root(monkeypatch: MonkeyPatch) -> None:  # pyright: ignore [reportUnusedFunction]
     """Simulate user has root."""

pyproject.toml

@@ -46,7 +46,7 @@ def test_actions_empty(self, get_namespace: Args):
         parser.parse_args(namespace=get_namespace)
 
         # Check there is no attrs
-        assert not any([getattr(get_namespace, attr) for attr in self.get_all_args_from_namespace(get_namespace)])
+        assert not any(getattr(get_namespace, attr) for attr in self.get_all_args_from_namespace(get_namespace))
 
     @pytest.mark.parametrize(
         "is_short_name",
@@ -66,4 +66,4 @@ def test_actions(self, is_short_name: bool, get_namespace: Args, get_parser_acti
         parser.parse_args(args=action_list, namespace=get_namespace)
 
         # Check all attrs are set
-        assert all([getattr(get_namespace, attr) for attr in self.get_all_args_from_namespace(get_namespace)])
+        assert all(getattr(get_namespace, attr) for attr in self.get_all_args_from_namespace(get_namespace))

tests/conftest.py

@@ -45,7 +45,7 @@ def test_cmd(command: str | int, ignore_errors: bool, output: str):
         (123, None),
     ],
 )
-def test_expanduser(str_path: str | int, output: Optional[str], get_current_os: str):
+def test_expanduser(str_path: str | int, output: Optional[str]):
     """Test wrapper of :meth:`pathlib.Path.expanduser` in :meth:`mac_cleanup.utils.expanduser`"""
 
     from mac_cleanup.utils import expanduser
@@ -56,7 +56,7 @@ def test_expanduser(str_path: str | int, output: Optional[str], get_current_os:
         return
 
     if output is None:
-        assert expanduser(str_path=str_path).startswith("/Users/" if get_current_os == "Darwin" else "/home/runner")
+        assert expanduser(str_path=str_path).startswith("/Users/")
         return
 
     assert expanduser(str_path=str_path) == "."

tests/test_parser.py

@@ -1,48 +1,32 @@
 [tox]
-minversion = 4.4.11
-envlist = python3.10, python3.11, pyright, ruff, black, isort, docformatter
+minversion = 4.5.0
+envlist = py310, py311, pyright, ruff, black, isort, docformatter
 isolated_build = True
 
 [gh-actions]
 python =
-    3.10: python3.10, pyright, ruff, black, isort, docformatter
-    3.11: python3.11
+    3.10: py310, pyright, ruff, black, isort, docformatter
+    3.11: py311
 
 [testenv]
-skip_install = true
-allowlist_externals = poetry
-deps =
-    poetry
-commands_pre =
-    poetry install --without dev,lint --no-root -v
+basepython =
+    py310, pyright, ruff, black, isort, docformatter: python3.10
+    py311: python3.11
 setenv =
     PYTHONPATH = {toxinidir}
-commands =
-    poetry run pytest
-
-[testenv:{pyright, ruff}]
+    py310, py311: GROUP = main,test
+    pyright, ruff: GROUP = main,test
+    black, isort, docformatter: GROUP = lint
 skip_install = true
 allowlist_externals = poetry
 deps =
     poetry
 commands_pre =
-    poetry install --without dev,lint --no-root -v
-setenv =
-    PYTHONPATH = {toxinidir}
+    poetry install --only "{env:GROUP}" --no-root -v
 commands =
+    py310, py311: poetry run pytest
     pyright: poetry run pyright
     ruff: poetry run ruff check .
-
-[testenv:{black, isort, docformatter}]
-skip_install = true
-allowlist_externals = poetry
-deps =
-    poetry
-commands_pre =
-    poetry install --only lint --no-root -v
-setenv =
-    PYTHONPATH = {toxinidir}
-commands =
     black: poetry run black . --check
     isort: poetry run isort . -c
     docformatter: poetry run docformatter -cr . --config ./pyproject.toml