Merge v3.0.4 to main

Author: efa2d19

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,21 +7,37 @@ assignees: Drugsosos
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+Describe The Bug
+---
+
+_A clear and concise description of what the bug is._
+
+Version
+---
+
+_Specify the version where the bug appeared_
+
+How To Reproduce
+---
+
+_Steps to reproduce the behavior_
 
-**To Reproduce**
-Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
-4. See error
+4. See something
+
+Expected Behavior
+---
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+_A clear and concise description of what you expect to happen._
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+Screenshots
+---
+
+_If applicable, add screenshots to help explain your problem._
+
+Additional Context
+---
 
-**Additional context**
-Add any other context about the problem here.
+_Add any other context about the problem here._

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,14 +7,25 @@ assignees: Drugsosos
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+Is your feature request related to a problem?
+---
+
+_A clear and concise description of what the problem is._
+
+#### Example
+> I'm always frustrated when [...]
+
+Describe the solution you'd like
+---
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+_A clear and concise description of what you want to happen._
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+Describe alternatives you've considered
+---
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+Additional Context
+---
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+_Add any other context or screenshots about the feature request here._

.github/ISSUE_TEMPLATE/questions.md

@@ -1,11 +1,13 @@
 ---
 name: Questions
-about: Describe your question here
+about: Ask your questions here
 title: ''
 labels: question
 assignees: Drugsosos
 
 ---
 
-**Question**
-Describe details of your question here.
+Question
+---
+
+_Describe details of your question here._

.github/pull_request_template.md

@@ -1,16 +1,20 @@
-### Title of Pull Request
+Title of Pull Request
+---
 
-Fixes #[Issue Number]
+#### Example
+> Fixes #[Issue Number]
 
-#### Description
+Description
+---
 
 _Briefly describe the changes in this pull request._
 
 - [Summary of major changes]
 - [Summary of minor changes]
 - [Any other relevant information]
 
-#### Type of Change
+Type of Change
+---
 
 Please delete options that are not relevant.
 
@@ -19,15 +23,17 @@ Please delete options that are not relevant.
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
 
-#### How Has This Been Tested?
+How Has This Been Tested?
+---
 
 Please describe the tests that you ran to verify your changes.
 Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
 
 - [ ] Test A
 - [ ] Test B
 
-#### Checklist:
+Checklist
+---
 
 - [ ] My code follows the style guidelines of this project
 - [ ] I have performed a self-review of my own code
@@ -39,10 +45,12 @@ Provide instructions so we can reproduce. Please also list any relevant details
 - [ ] New and existing unit tests pass locally with my changes
 - [ ] Any dependent changes have been merged and published in downstream modules
 
-#### Screenshots (if applicable)
+Screenshots
+---
 
 _Attach screenshots or screen recordings of the changes, if any._
 
-#### Additional Context
+Additional Context
+---
 
 _Add any other context or information about the pull request here._

README.md

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

bumpVersion.sh

@@ -0,0 +1,18 @@
+#! /bin/bash
+
+# Check no version
+if [[ -z "$1" ]]; then echo "No version supplied"; exit 1; fi
+
+# Check incorrect version
+if ! echo "$1" | grep -Eq '^[0-9]+\.[0-9]\.[0-9]+$'; then echo "Incorrect version"; exit 1; fi
+
+# Get current version
+currentVersion="$(grep -oE '(?:^version = \")(\d|\.)+(?:\")' pyproject.toml | sed -r 's/^version = "(([0-9]|\.)+)"/\1/g')"
+
+# Replace in pyproject
+sed -ri "" "s/^version = \"$currentVersion\"/version = \"$1\"/g" ./pyproject.toml
+
+# Replace in README
+sed -ri "" "s/$currentVersion/$1/g" ./README.md
+
+exit 0

mac_cleanup/__init__.py

@@ -1,7 +1,7 @@
+from mac_cleanup.parser import args  # isort: skip_file
 from mac_cleanup.core import ProxyCollector as Collector
 from mac_cleanup.core_modules import Command, Path
 from mac_cleanup.main import EntryPoint
-from mac_cleanup.parser import args
 
 try:
     from mac_cleanup.__version__ import __version__

mac_cleanup/core_modules.py

@@ -5,6 +5,7 @@
 
 from beartype import beartype  # pyright: ignore [reportUnknownVariableType]
 
+from mac_cleanup import args
 from mac_cleanup.progress import ProgressBar
 from mac_cleanup.utils import check_deletable, check_exists, cmd
 
@@ -27,6 +28,9 @@ def with_prompt(self: T, message_: Optional[str] = None) -> T:
         :class: `BaseModule`
         """
 
+        if args.force:
+            return self
+
         # Can't be solved without typing.Self
         self.__prompt = True  # pyright: ignore [reportGeneralTypeIssues]
 
@@ -73,11 +77,11 @@ def get_command(self) -> Optional[str]:
         return self.__command
 
     @abstractmethod
-    def _execute(self, **kwargs: bool) -> Optional[str]:
+    def _execute(self, ignore_errors: bool = True) -> Optional[str]:
         """
         Execute the command specified.
 
-        :param ignore_errors_: Ignore errors during execution
+        :param ignore_errors: Ignore errors during execution
         :return: Command execution results based on specified parameters
         """
 
@@ -90,7 +94,7 @@ def _execute(self, **kwargs: bool) -> Optional[str]:
             return
 
         # Execute command
-        return cmd(command=self.__command, ignore_errors=kwargs.get("ignore_errors", True))
+        return cmd(command=self.__command, ignore_errors=ignore_errors)
 
 
 @final
@@ -106,8 +110,15 @@ def with_errors(self) -> "Command":
 
         return self
 
-    def _execute(self) -> Optional[str]:
-        return super()._execute(ignore_errors=self.__ignore_errors)
+    def _execute(self, ignore_errors: Optional[bool] = None) -> Optional[str]:
+        """
+        Execute the command specified.
+
+        :param ignore_errors: Overrides flag `ignore_errors` in class
+        :return: Command execution results based on specified parameters
+        """
+
+        return super()._execute(ignore_errors=self.__ignore_errors if ignore_errors is None else ignore_errors)
 
 
 @final
@@ -137,7 +148,7 @@ def dry_run_only(self) -> "Path":
 
         return self
 
-    def _execute(self) -> Optional[str]:
+    def _execute(self, ignore_errors: bool = True) -> Optional[str]:
         """Delete specified path :return: Command execution results based on specified
         parameters.
         """
@@ -149,4 +160,4 @@ def _execute(self) -> Optional[str]:
         if not all([check_deletable(path=self.__path), check_exists(path=self.__path, expand_user=False)]):
             return
 
-        return super()._execute()  # Always ignore errors
+        return super()._execute(ignore_errors=ignore_errors)

mac_cleanup/default_modules.py

@@ -417,3 +417,25 @@ def inactive_memory():
     with clc as unit:
         unit.message("Purging inactive memory")
         unit.add(Command("sudo purge"))
+
+
+def telegram():
+    from mac_cleanup.utils import cmd
+
+    with clc as unit:
+        unit.message("Clear old Telegram cache")
+
+        reopen_telegram = False
+
+        if cmd("ps aux | grep '[T]elegram'"):
+            reopen_telegram = True
+            unit.add(Command("killall -KILL Telegram"))
+
+        unit.add(
+            Path("~/Library/Group Containers/*.ru.keepcoder.Telegram/stable/account-*/postbox/db").with_prompt(
+                "Telegram cache will be deleted. Once reopened, cache will be rebuild smaller. Continue?"
+            )
+        )
+
+        if reopen_telegram:
+            unit.add(Command("open /Applications/Telegram.app"))

mac_cleanup/parser.py

@@ -14,6 +14,7 @@ class Args:
     update: bool = attr.ib(default=False)
     configure: bool = attr.ib(default=False)
     custom_path: bool = attr.ib(default=False)
+    force: bool = attr.ib(default=False)
 
 
 parser = ArgumentParser(
@@ -25,17 +26,20 @@ class Args:
     formatter_class=RawTextHelpFormatter,
 )
 
-parser.add_argument("-n", "--dry-run", help="Dry run without deleting stuff", action="store_true")
+parser.add_argument("-n", "--dry-run", help="Run without deleting stuff", action="store_true")
 
-parser.add_argument("-u", "--update", help="Update HomeBrew on cleanup", action="store_true")
+parser.add_argument("-u", "--update", help="Update Homebrew on cleanup", action="store_true")
 
-parser.add_argument("-c", "--configure", help="Configure default and custom modules", action="store_true")
+parser.add_argument("-c", "--configure", help="Open module configuration screen", action="store_true")
 
 parser.add_argument("-p", "--custom-path", help="Specify path for custom modules", action="store_true")
 
+parser.add_argument("-f", "--force", help="Accept all warnings", action="store_true")
+
 args = Args()
 parser.parse_args(namespace=args)
 
 # args.dry_run = True  # debug
 # args.configure = True  # debug
 # args.custom_path = True  # debug
+# args.force = True  # debug