crackerjack 0.30.3__py3-none-any.whl → 0.31.7__py3-none-any.whl

crackerjack/services/filesystem.py

@@ -0,0 +1,421 @@
+import shutil
+from collections.abc import Iterator
+from pathlib import Path
+
+from crackerjack.errors import ErrorCode, FileError, ResourceError
+
+
+class FileSystemService:
+    @staticmethod
+    def clean_trailing_whitespace_and_newlines(content: str) -> str:
+        """Clean trailing whitespace from all lines and ensure single trailing newline.
+
+        Args:
+            content: File content to clean
+
+        Returns:
+            Cleaned content with no trailing whitespace and single trailing newline
+        """
+        # Remove trailing whitespace from each line
+        lines = content.splitlines()
+        cleaned_lines = [line.rstrip() for line in lines]
+
+        # Join lines and ensure exactly one trailing newline
+        result = "\n".join(cleaned_lines)
+        if result and not result.endswith("\n"):
+            result += "\n"
+
+        return result
+
+    def read_file(self, path: str | Path) -> str:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if not path_obj.exists():
+                raise FileError(
+                    message=f"File does not exist: {path_obj}",
+                    details=f"Attempted to read file at {path_obj.absolute()}",
+                    recovery="Check file path and ensure file exists",
+                )
+            return path_obj.read_text(encoding="utf-8")
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied reading file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions and user access rights",
+            ) from e
+        except UnicodeDecodeError as e:
+            raise FileError(
+                message=f"Unable to decode file as UTF-8: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Ensure file is text-based and UTF-8 encoded",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error reading file: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check disk space and file system integrity",
+            ) from e
+
+    def write_file(self, path: str | Path, content: str) -> None:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            try:
+                path_obj.parent.mkdir(parents=True, exist_ok=True)
+            except OSError as e:
+                raise FileError(
+                    message=f"Cannot create parent directories for: {path}",
+                    error_code=ErrorCode.FILE_WRITE_ERROR,
+                    details=str(e),
+                    recovery="Check disk space and directory permissions",
+                ) from e
+
+            # Auto-clean configuration files to prevent pre-commit hook failures
+            if path_obj.name in {".pre-commit-config.yaml", "pyproject.toml"}:
+                content = self.clean_trailing_whitespace_and_newlines(content)
+
+            path_obj.write_text(content, encoding="utf-8")
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied writing file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file and directory permissions",
+            ) from e
+        except OSError as e:
+            if "No space left on device" in str(e):
+                raise ResourceError(
+                    message=f"Insufficient disk space to write file: {path}",
+                    details=str(e),
+                    recovery="Free up disk space and try again",
+                ) from e
+            raise FileError(
+                message=f"System error writing file: {path}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Check disk space and file system integrity",
+            ) from e
+
+    def exists(self, path: str | Path) -> bool:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            return path_obj.exists()
+        except OSError:
+            return False
+
+    def mkdir(self, path: str | Path, parents: bool = False) -> None:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            path_obj.mkdir(parents=parents, exist_ok=True)
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied creating directory: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check parent directory permissions",
+            ) from e
+        except FileExistsError as e:
+            if not parents:
+                raise FileError(
+                    message=f"Directory already exists: {path}",
+                    details=str(e),
+                    recovery="Use exist_ok=True or check if directory exists first",
+                ) from e
+        except OSError as e:
+            if "No space left on device" in str(e):
+                raise ResourceError(
+                    message=f"Insufficient disk space to create directory: {path}",
+                    details=str(e),
+                    recovery="Free up disk space and try again",
+                ) from e
+            raise FileError(
+                message=f"System error creating directory: {path}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Check disk space and file system integrity",
+            ) from e
+
+    def glob(self, pattern: str, path: str | Path | None = None) -> list[Path]:
+        base_path = Path(path) if path else Path.cwd()
+        try:
+            if not base_path.exists():
+                raise FileError(
+                    message=f"Base path does not exist: {base_path}",
+                    details=f"Attempted to glob in {base_path.absolute()}",
+                    recovery="Check base path and ensure directory exists",
+                )
+            return list(base_path.glob(pattern))
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied accessing directory: {base_path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check directory permissions",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error during glob operation: {pattern}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check path validity and file system integrity",
+            ) from e
+
+    def rglob(self, pattern: str, path: str | Path | None = None) -> list[Path]:
+        base_path = Path(path) if path else Path.cwd()
+        try:
+            if not base_path.exists():
+                raise FileError(
+                    message=f"Base path does not exist: {base_path}",
+                    details=f"Attempted to rglob in {base_path.absolute()}",
+                    recovery="Check base path and ensure directory exists",
+                )
+            return list(base_path.rglob(pattern))
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied accessing directory: {base_path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check directory permissions",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error during recursive glob operation: {pattern}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check path validity and file system integrity",
+            ) from e
+
+    def copy_file(self, src: str | Path, dst: str | Path) -> None:
+        src_path, dst_path = self._normalize_copy_paths(src, dst)
+        self._validate_copy_source(src_path)
+        self._prepare_copy_destination(dst_path)
+        self._perform_file_copy(src_path, dst_path, src, dst)
+
+    def _normalize_copy_paths(
+        self, src: str | Path, dst: str | Path
+    ) -> tuple[Path, Path]:
+        src_path = Path(src) if isinstance(src, str) else src
+        dst_path = Path(dst) if isinstance(dst, str) else dst
+        return src_path, dst_path
+
+    def _validate_copy_source(self, src_path: Path) -> None:
+        if not src_path.exists():
+            raise FileError(
+                message=f"Source file does not exist: {src_path}",
+                details=f"Attempted to copy from {src_path.absolute()}",
+                recovery="Check source file path and ensure file exists",
+            )
+        if not src_path.is_file():
+            raise FileError(
+                message=f"Source is not a file: {src_path}",
+                details=f"Source is a {src_path.stat().st_mode} type",
+                recovery="Ensure source path points to a regular file",
+            )
+
+    def _prepare_copy_destination(self, dst_path: Path) -> None:
+        try:
+            dst_path.parent.mkdir(parents=True, exist_ok=True)
+        except OSError as e:
+            raise FileError(
+                message=f"Cannot create destination parent directories: {dst_path.parent}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Check disk space and directory permissions",
+            ) from e
+
+    def _perform_file_copy(
+        self, src_path: Path, dst_path: Path, src: str | Path, dst: str | Path
+    ) -> None:
+        try:
+            shutil.copy2(src_path, dst_path)
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied copying file: {src} -> {dst}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file and directory permissions",
+            ) from e
+        except shutil.SameFileError as e:
+            raise FileError(
+                message=f"Source and destination are the same file: {src}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Ensure source and destination paths are different",
+            ) from e
+        except OSError as e:
+            if "No space left on device" in str(e):
+                raise ResourceError(
+                    message=f"Insufficient disk space to copy file: {src} -> {dst}",
+                    details=str(e),
+                    recovery="Free up disk space and try again",
+                ) from e
+            raise FileError(
+                message=f"System error copying file: {src} -> {dst}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Check disk space and file system integrity",
+            ) from e
+
+    def remove_file(self, path: str | Path) -> None:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if path_obj.exists():
+                if not path_obj.is_file():
+                    raise FileError(
+                        message=f"Path is not a file: {path_obj}",
+                        details=f"Path type: {path_obj.stat().st_mode}",
+                        recovery="Use appropriate method for directory removal",
+                    )
+                path_obj.unlink()
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied removing file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions and ownership",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error removing file: {path}",
+                error_code=ErrorCode.FILE_WRITE_ERROR,
+                details=str(e),
+                recovery="Check file system integrity and try again",
+            ) from e
+
+    def get_file_size(self, path: str | Path) -> int:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if not path_obj.exists():
+                raise FileError(
+                    message=f"File does not exist: {path_obj}",
+                    details=f"Attempted to get size of {path_obj.absolute()}",
+                    recovery="Check file path and ensure file exists",
+                )
+            if not path_obj.is_file():
+                raise FileError(
+                    message=f"Path is not a file: {path_obj}",
+                    details=f"Path type: {path_obj.stat().st_mode}",
+                    recovery="Ensure path points to a regular file",
+                )
+            return path_obj.stat().st_size
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied accessing file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error getting file size: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check file system integrity",
+            ) from e
+
+    def get_file_mtime(self, path: str | Path) -> float:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if not path_obj.exists():
+                raise FileError(
+                    message=f"File does not exist: {path_obj}",
+                    details=f"Attempted to get mtime of {path_obj.absolute()}",
+                    recovery="Check file path and ensure file exists",
+                )
+            if not path_obj.is_file():
+                raise FileError(
+                    message=f"Path is not a file: {path_obj}",
+                    details=f"Path type: {path_obj.stat().st_mode}",
+                    recovery="Ensure path points to a regular file",
+                )
+            return path_obj.stat().st_mtime
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied accessing file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error getting file modification time: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check file system integrity",
+            ) from e
+
+    def read_file_chunked(
+        self,
+        path: str | Path,
+        chunk_size: int = 8192,
+    ) -> Iterator[str]:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if not path_obj.exists():
+                raise FileError(
+                    message=f"File does not exist: {path_obj}",
+                    details=f"Attempted to read file at {path_obj.absolute()}",
+                    recovery="Check file path and ensure file exists",
+                )
+
+            with path_obj.open(encoding="utf-8") as file:
+                while chunk := file.read(chunk_size):
+                    yield chunk
+
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied reading file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions",
+            ) from e
+        except UnicodeDecodeError as e:
+            raise FileError(
+                message=f"File encoding error: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Ensure file is encoded in UTF-8",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error reading file: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check file system integrity",
+            ) from e
+
+    def read_lines_streaming(self, path: str | Path) -> Iterator[str]:
+        try:
+            path_obj = Path(path) if isinstance(path, str) else path
+            if not path_obj.exists():
+                raise FileError(
+                    message=f"File does not exist: {path_obj}",
+                    details=f"Attempted to read file at {path_obj.absolute()}",
+                    recovery="Check file path and ensure file exists",
+                )
+            with path_obj.open(encoding="utf-8") as file:
+                for line in file:
+                    yield line.rstrip("\n\r")
+        except PermissionError as e:
+            raise FileError(
+                message=f"Permission denied reading file: {path}",
+                error_code=ErrorCode.PERMISSION_ERROR,
+                details=str(e),
+                recovery="Check file permissions",
+            ) from e
+        except UnicodeDecodeError as e:
+            raise FileError(
+                message=f"File encoding error: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Ensure file is encoded in UTF-8",
+            ) from e
+        except OSError as e:
+            raise FileError(
+                message=f"System error reading file: {path}",
+                error_code=ErrorCode.FILE_READ_ERROR,
+                details=str(e),
+                recovery="Check file system integrity",
+            ) from e

crackerjack/services/git.py

@@ -0,0 +1,176 @@
+import subprocess
+from pathlib import Path
+
+from rich.console import Console
+
+
+class GitService:
+    def __init__(self, console: Console, pkg_path: Path | None = None) -> None:
+        self.console = console
+        self.pkg_path = pkg_path or Path.cwd()
+
+    def _run_git_command(self, args: list[str]) -> subprocess.CompletedProcess[str]:
+        cmd = ["git", *args]
+        return subprocess.run(
+            cmd,
+            check=False,
+            cwd=self.pkg_path,
+            capture_output=True,
+            text=True,
+            timeout=60,
+        )
+
+    def is_git_repo(self) -> bool:
+        try:
+            result = self._run_git_command(["rev-parse", "--git-dir"])
+            return result.returncode == 0
+        except (subprocess.SubprocessError, OSError, FileNotFoundError):
+            return False
+
+    def get_changed_files(self) -> list[str]:
+        try:
+            staged_result = self._run_git_command(["diff", "--cached", "--name-only"])
+            staged_files = (
+                staged_result.stdout.strip().split("\n")
+                if staged_result.stdout.strip()
+                else []
+            )
+            unstaged_result = self._run_git_command(["diff", "--name-only"])
+            unstaged_files = (
+                unstaged_result.stdout.strip().split("\n")
+                if unstaged_result.stdout.strip()
+                else []
+            )
+            untracked_result = self._run_git_command(
+                ["ls-files", "--others", "--exclude-standard"],
+            )
+            untracked_files = (
+                untracked_result.stdout.strip().split("\n")
+                if untracked_result.stdout.strip()
+                else []
+            )
+            all_files = set(staged_files + unstaged_files + untracked_files)
+            return [f for f in all_files if f]
+        except Exception as e:
+            self.console.print(f"[yellow]⚠️[/yellow] Error getting changed files: {e}")
+            return []
+
+    def get_staged_files(self) -> list[str]:
+        try:
+            result = self._run_git_command(["diff", "--cached", "--name-only"])
+            return result.stdout.strip().split("\n") if result.stdout.strip() else []
+        except Exception as e:
+            self.console.print(f"[yellow]⚠️[/yellow] Error getting staged files: {e}")
+            return []
+
+    def add_files(self, files: list[str]) -> bool:
+        try:
+            for file in files:
+                result = self._run_git_command(["add", file])
+                if result.returncode != 0:
+                    self.console.print(
+                        f"[red]❌[/red] Failed to add {file}: {result.stderr}",
+                    )
+                    return False
+            return True
+        except Exception as e:
+            self.console.print(f"[red]❌[/red] Error adding files: {e}")
+            return False
+
+    def commit(self, message: str) -> bool:
+        try:
+            result = self._run_git_command(["commit", "-m", message])
+            if result.returncode == 0:
+                self.console.print(f"[green]✅[/green] Committed: {message}")
+                return True
+
+            # When git commit fails due to pre-commit hooks, stderr contains hook output
+            # Use a more appropriate error message for commit failures
+            if "pre-commit" in result.stderr or "hook" in result.stderr.lower():
+                self.console.print("[red]❌[/red] Commit blocked by pre-commit hooks")
+                if result.stderr.strip():
+                    # Show hook output in a more readable way
+                    self.console.print(
+                        f"[yellow]Hook output:[/yellow]\n{result.stderr.strip()}"
+                    )
+            else:
+                self.console.print(f"[red]❌[/red] Commit failed: {result.stderr}")
+            return False
+        except Exception as e:
+            self.console.print(f"[red]❌[/red] Error committing: {e}")
+            return False
+
+    def push(self) -> bool:
+        try:
+            result = self._run_git_command(["push"])
+            if result.returncode == 0:
+                self.console.print("[green]✅[/green] Pushed to remote")
+                return True
+            self.console.print(f"[red]❌[/red] Push failed: {result.stderr}")
+            return False
+        except Exception as e:
+            self.console.print(f"[red]❌[/red] Error pushing: {e}")
+            return False
+
+    def get_current_branch(self) -> str | None:
+        try:
+            result = self._run_git_command(["branch", "--show-current"])
+            return result.stdout.strip() if result.returncode == 0 else None
+        except (subprocess.SubprocessError, OSError, FileNotFoundError):
+            return None
+
+    def get_commit_message_suggestions(self, files: list[str]) -> list[str]:
+        if not files:
+            return ["Update project files"]
+        file_categories = self._categorize_files(files)
+        messages = self._generate_category_messages(file_categories)
+        messages.extend(self._generate_specific_messages(files))
+
+        return messages[:5]
+
+    def _categorize_files(self, files: list[str]) -> set[str]:
+        categories = {
+            "docs": ["README", "CLAUDE", "docs/", ".md"],
+            "tests": ["test_", "tests/", "conftest.py"],
+            "config": ["pyproject.toml", ".yaml", ".yml", ".json", ".gitignore"],
+            "ci": [".github/", "ci/", ".pre-commit"],
+            "deps": ["requirements", "uv.lock", "Pipfile"],
+        }
+        file_categories: set[str] = set()
+        for file in files:
+            category = self._get_file_category(file, categories)
+            file_categories.add(category)
+
+        return file_categories
+
+    def _get_file_category(self, file: str, categories: dict[str, list[str]]) -> str:
+        for category, patterns in categories.items():
+            if any(pattern in file for pattern in patterns):
+                return category
+        return "core"
+
+    def _generate_category_messages(self, file_categories: set[str]) -> list[str]:
+        if len(file_categories) == 1:
+            return self._generate_single_category_message(next(iter(file_categories)))
+        return [f"Update {', '.join(sorted(file_categories))}"]
+
+    def _generate_single_category_message(self, category: str) -> list[str]:
+        category_messages = {
+            "docs": "Update documentation",
+            "tests": "Update tests",
+            "config": "Update configuration",
+            "ci": "Update CI/CD configuration",
+            "deps": "Update dependencies",
+        }
+        return [category_messages.get(category, "Update core functionality")]
+
+    def _generate_specific_messages(self, files: list[str]) -> list[str]:
+        messages: list[str] = []
+        if "pyproject.toml" in files:
+            messages.append("Update project configuration")
+        if any("test_" in f for f in files):
+            messages.append("Improve test coverage")
+        if "README.md" in files:
+            messages.append("Update README documentation")
+
+        return messages