ripperdoc 0.2.0__py3-none-any.whl → 0.2.3__py3-none-any.whl

ripperdoc/tools/todo_tool.py

@@ -14,6 +14,7 @@ from ripperdoc.core.tool import (
     ToolUseExample,
     ValidationResult,
 )
+from ripperdoc.utils.log import get_logger
 from ripperdoc.utils.todo import (
     TodoItem,
     TodoPriority,
@@ -27,9 +28,14 @@ from ripperdoc.utils.todo import (
     validate_todos,
 )
 
+logger = get_logger()
+
+DEFAULT_ACTION = "Edit"
+
 TODO_WRITE_PROMPT = dedent(
-    """\
-    Use this tool to create and manage a structured task list for your current coding session. This helps you track progress, organize complex tasks, and demonstrate thoroughness to the user. It also helps the user understand the progress of the task and overall progress of their requests.
+    f"""\
+    Use this tool to create and manage a structured task list for your current coding session. This helps you track progress, organize complex tasks, and demonstrate thoroughness to the user.
+    It also helps the user understand the progress of the task and overall progress of their requests.
 
     ## When to Use This Tool
     Use this tool proactively in these scenarios:
@@ -52,30 +58,155 @@ TODO_WRITE_PROMPT = dedent(
 
     NOTE that you should not use this tool if there is only one trivial task to do. In this case you are better off just doing the task directly.
 
+    ## Examples of When to Use the Todo List
+
+    <example>
+    User: I want to add a dark mode toggle to the application settings. Make sure you run the tests and build when you're done!
+    Assistant: I'll help add a dark mode toggle to your application settings. Let me create a todo list to track this implementation.
+    *Creates todo list with the following items:*
+    1. Create dark mode toggle component in Settings page
+    2. Add dark mode state management (context/store)
+    3. Implement CSS-in-JS styles for dark theme
+    4. Update existing components to support theme switching
+    5. Run tests and build process, addressing any failures or errors that occur
+    *Begins working on the first task*
+
+    <reasoning>
+    The assistant used the todo list because:
+    1. Adding dark mode is a multi-step feature requiring UI, state management, and styling changes
+    2. The user explicitly requested tests and build be run afterward
+    3. The assistant inferred that tests and build need to pass by adding "Ensure tests and build succeed" as the final task
+    </reasoning>
+    </example>
+
+    <example>
+    User: Help me rename the function getCwd to getCurrentWorkingDirectory across my project
+    Assistant: Let me first search through your codebase to find all occurrences of 'getCwd'.
+    *Uses grep or search tools to locate all instances of getCwd in the codebase*
+    Assistant: I've found 15 instances of 'getCwd' across 8 different files. Let me create a todo list to track these changes.
+    *Creates todo list with specific items for each file that needs updating*
+
+    <reasoning>
+    The assistant used the todo list because:
+    1. First, the assistant searched to understand the scope of the task
+    2. Upon finding multiple occurrences across different files, it determined this was a complex task with multiple steps
+    3. The todo list helps ensure every instance is tracked and updated systematically
+    4. This approach prevents missing any occurrences and maintains code consistency
+    </reasoning>
+    </example>
+
+
+    <example>
+    User: I need to implement these features for my e-commerce site: user registration, product catalog, shopping cart, and checkout flow.
+    Assistant: I'll help implement these features. First, let's add all the features to the todo list.
+    *Creates a todo list breaking down each feature into specific tasks based on the project architecture*
+    Assistant: Let's start with user registration. This will involve creating database models, API endpoints, and frontend forms that integrate with your existing authentication system.
+
+    <reasoning>
+    The assistant used the todo list because:
+    1. The user provided multiple complex features to implement in a comma separated list
+    2. The todo list helps organize these large features into manageable tasks
+    3. This approach allows for tracking progress across the entire implementation
+    </reasoning>
+    </example>
+
+    <example>
+    User: Can you help optimize my React application? It's rendering slowly and has performance issues.</user>
+    Assistant: I'll help optimize your React application. First, let me examine your codebase to identify potential performance bottlenecks.
+    *Reviews component structure, render patterns, state management, and data fetching*
+    Assistant: After analyzing your codebase, I've identified several performance issues. Let me create a todo list to track our optimization efforts.
+    *Creates todo list with items like: 1) Implement memoization for expensive calculations in ProductList, 2) Add virtualization for long lists in Dashboard, 3) Optimize image loading in Gallery component, 4) Fix state update loops in ShoppingCart, 5) Review bundle size and implement code splitting*
+    Let's start by implementing memoization for the expensive calculations in your ProductList component.</assistant>
+
+    <reasoning>
+    The assistant used the todo list because:
+    1. First, the assistant examined the codebase to identify specific performance issues
+    2. Based on this analysis, it identified multiple optimization opportunities
+    3. Performance optimization is a non-trivial task requiring multiple steps
+    4. The todo list helps methodically track improvements across different components
+    5. This systematic approach ensures all performance bottlenecks are addressed
+    </reasoning>
+    </example>
+
+    ## Examples of When NOT to Use the Todo List
+
+    <example>
+    User: How do I print 'Hello World' in Python?
+    Assistant: In Python, you can print "Hello World" with this simple code:
+
+    python
+    print("Hello World")
+
+    This will output the text "Hello World" to the console when executed.</assistant>
+
+    <reasoning>
+    The assistant did not use the todo list because this is a single, trivial task that can be completed in one step. There's no need to track multiple tasks or steps for such a straightforward request.
+    </reasoning>
+    </example>
+
+    <example>
+    User: What does the git status command do?
+    Assistant: The git status command shows the current state of your working directory and staging area. It displays which changes have been staged, which haven't, and which files aren't being tracked by Git. This is a fundamental command for understanding the current state of your repository before making commits.
+
+    <reasoning>
+    The assistant did not use the todo list because this is an informational request with no actual coding task to complete. The user is simply asking for an explanation, not for the assistant to perform multiple steps or tasks.
+    </reasoning>
+    </example>
+
+    <example>
+    User: Can you add a comment to the calculateTotal function to explain what it does?
+    Assistant: Sure, let me add a comment to the calculateTotal function to explain what it does.
+    * Uses the ${DEFAULT_ACTION} tool to add a comment to the calculateTotal function *
+
+    <reasoning>
+    The assistant did not use the todo list because this is a single, straightforward task confined to one location in the code. Adding a comment doesn't require tracking multiple steps or systematic organization.
+    </reasoning>
+    </example>
+
+    <example>
+    User: Run npm install for me and tell me what happens.
+    Assistant: I'll run the npm install command for you.
+
+    *Executes: npm install*
+
+    The command completed successfully. Here's the output:
+    [Output of npm install command]
+
+    All dependencies have been installed according to your package.json file.
+
+    <reasoning>
+    The assistant did not use the todo list because this is a single command execution with immediate results. There are no multiple steps to track or organize, making the todo list unnecessary for this straightforward task.
+    </reasoning>
+    </example>
+
     ## Task States and Management
 
-    1. Task States:
-       - pending: Task not yet started
-       - in_progress: Currently working on (limit to ONE task at a time)
-       - completed: Task finished successfully
-
-    2. Task Management:
-       - Update task status in real-time as you work
-       - Mark tasks complete IMMEDIATELY after finishing (don't batch completions)
-       - Only have ONE task in_progress at any time
-       - Complete current tasks before starting new ones
-       - Remove tasks that are no longer relevant from the list entirely
-
-    3. Task Completion Requirements:
-       - ONLY mark a task as completed when you have FULLY accomplished it
-       - If you encounter errors, blockers, or cannot finish, keep the task as in_progress
-       - When blocked, create a new task describing what needs to be resolved
-       - Never mark a task as completed if tests are failing, implementation is partial, errors are unresolved, or needed files are missing
-
-    4. Task Breakdown:
-       - Create specific, actionable items
-       - Break complex tasks into smaller, manageable steps
-       - Use clear, descriptive task names
+    1. **Task States**: Use these states to track progress:
+    - pending: Task not yet started
+    - in_progress: Currently working on (limit to ONE task at a time)
+    - completed: Task finished successfully
+
+    2. **Task Management**:
+    - Update task status in real-time as you work
+    - Mark tasks complete IMMEDIATELY after finishing (don't batch completions)
+    - Only have ONE task in_progress at any time
+    - Complete current tasks before starting new ones
+    - Remove tasks that are no longer relevant from the list entirely
+
+    3. **Task Completion Requirements**:
+    - ONLY mark a task as completed when you have FULLY accomplished it
+    - If you encounter errors, blockers, or cannot finish, keep the task as in_progress
+    - When blocked, create a new task describing what needs to be resolved
+    - Never mark a task as completed if:
+        - Tests are failing
+        - Implementation is partial
+        - You encountered unresolved errors
+        - You couldn't find necessary files or dependencies
+
+    4. **Task Breakdown**:
+    - Create specific, actionable items
+    - Break complex tasks into smaller, manageable steps
+    - Use clear, descriptive task names
 
     When in doubt, use this tool. Being proactive with task management demonstrates attentiveness and ensures you complete all requirements successfully.
     """
@@ -130,7 +261,7 @@ class TodoWriteTool(Tool[TodoWriteToolInput, TodoToolOutput]):
         return "TodoWrite"
 
     async def description(self) -> str:
-        return "Create and update a structured task list for the current session."
+        return "Update the todo list for the current session. To be used proactively and often to track progress and pending tasks."
 
     @property
     def input_schema(self) -> type[TodoWriteToolInput]:
@@ -230,6 +361,7 @@ class TodoWriteTool(Tool[TodoWriteToolInput, TodoToolOutput]):
             )
             yield ToolResult(data=output, result_for_assistant=result_text)
         except Exception as exc:
+            logger.exception("[todo_tool] Error updating todos", extra={"error": str(exc)})
             error = f"Error updating todos: {exc}"
             yield ToolResult(
                 data=TodoToolOutput(

ripperdoc/tools/tool_search_tool.py

@@ -19,6 +19,10 @@ from ripperdoc.core.tool import (
     ValidationResult,
     build_tool_description,
 )
+from ripperdoc.utils.log import get_logger
+
+
+logger = get_logger()
 
 
 class ToolSearchInput(BaseModel):
@@ -115,7 +119,9 @@ class ToolSearchTool(Tool[ToolSearchInput, ToolSearchOutput]):
     def is_concurrency_safe(self) -> bool:
         return True
 
-    def needs_permissions(self, input_data: Optional[ToolSearchInput] = None) -> bool:  # noqa: ARG002
+    def needs_permissions(
+        self, input_data: Optional[ToolSearchInput] = None
+    ) -> bool:  # noqa: ARG002
         return False
 
     async def validate_input(
@@ -174,6 +180,7 @@ class ToolSearchTool(Tool[ToolSearchInput, ToolSearchOutput]):
                 regex = re.compile(normalized[1:-1], re.IGNORECASE)
             except re.error:
                 regex = None
+                logger.exception("[tool_search] Invalid regex search query", extra={"query": query})
 
         def _tokenize(text: str) -> List[str]:
             return re.findall(r"[a-z0-9]+", text.lower())
@@ -186,6 +193,10 @@ class ToolSearchTool(Tool[ToolSearchInput, ToolSearchOutput]):
                 )
             except Exception:
                 description = ""
+                logger.exception(
+                    "[tool_search] Failed to build tool description",
+                    extra={"tool_name": getattr(tool, "name", None)},
+                )
             doc_text = " ".join([name, tool.user_facing_name(), description])
             tokens = _tokenize(doc_text)
             corpus.append((name, tool, tokens, len(tokens), description))
@@ -271,9 +282,11 @@ class ToolSearchTool(Tool[ToolSearchInput, ToolSearchOutput]):
                     "name": name,
                     "user_facing_name": tool.user_facing_name(),
                     "description": description,
-                    "active": getattr(registry, "is_active", lambda *_: False)(name)
-                    if hasattr(registry, "is_active")
-                    else False,
+                    "active": (
+                        getattr(registry, "is_active", lambda *_: False)(name)
+                        if hasattr(registry, "is_active")
+                        else False
+                    ),
                     "deferred": name in getattr(registry, "deferred_names", set()),
                     "score": 0.0,
                 }

ripperdoc/utils/file_watch.py

@@ -0,0 +1,134 @@
+"""Lightweight file-change tracking for notifying the model about user edits."""
+
+from __future__ import annotations
+
+import difflib
+import os
+from dataclasses import dataclass
+from typing import Dict, List, Optional
+
+from ripperdoc.utils.log import get_logger
+
+logger = get_logger()
+
+
+@dataclass
+class FileSnapshot:
+    """Snapshot of a file read by the agent."""
+
+    content: str
+    timestamp: float
+    offset: int = 0
+    limit: Optional[int] = None
+
+
+@dataclass
+class ChangedFileNotice:
+    """Information about a file that changed after it was read."""
+
+    file_path: str
+    summary: str
+
+
+def record_snapshot(
+    file_path: str,
+    content: str,
+    cache: Dict[str, FileSnapshot],
+    *,
+    offset: int = 0,
+    limit: Optional[int] = None,
+) -> None:
+    """Store the current contents and mtime for a file."""
+    try:
+        timestamp = os.path.getmtime(file_path)
+    except OSError:
+        timestamp = 0.0
+    cache[file_path] = FileSnapshot(
+        content=content, timestamp=timestamp, offset=offset, limit=limit
+    )
+
+
+def _read_portion(file_path: str, offset: int, limit: Optional[int]) -> str:
+    with open(file_path, "r", encoding="utf-8", errors="replace") as handle:
+        lines = handle.readlines()
+    start = max(offset, 0)
+    if limit is None:
+        selected = lines[start:]
+    else:
+        selected = lines[start : start + limit]
+    return "".join(selected)
+
+
+def _build_diff_summary(old_content: str, new_content: str, file_path: str, max_lines: int) -> str:
+    diff = list(
+        difflib.unified_diff(
+            old_content.splitlines(),
+            new_content.splitlines(),
+            fromfile=file_path,
+            tofile=file_path,
+            lineterm="",
+        )
+    )
+    if not diff:
+        return "File was modified but contents appear unchanged."
+
+    # Keep the diff short to avoid flooding the model.
+    if len(diff) > max_lines:
+        diff = diff[:max_lines] + ["... (diff truncated)"]
+    return "\n".join(diff)
+
+
+def detect_changed_files(
+    cache: Dict[str, FileSnapshot], *, max_diff_lines: int = 80
+) -> List[ChangedFileNotice]:
+    """Return notices for files whose mtime increased since they were read."""
+    notices: List[ChangedFileNotice] = []
+
+    # Iterate over a static list so we can mutate cache safely.
+    for file_path, snapshot in list(cache.items()):
+        try:
+            current_mtime = os.path.getmtime(file_path)
+        except OSError:
+            notices.append(
+                ChangedFileNotice(
+                    file_path=file_path, summary="File was deleted or is no longer accessible."
+                )
+            )
+            cache.pop(file_path, None)
+            continue
+
+        if current_mtime <= snapshot.timestamp:
+            continue
+
+        try:
+            new_content = _read_portion(file_path, snapshot.offset, snapshot.limit)
+        except Exception as exc:  # pragma: no cover - best-effort telemetry
+            logger.exception(
+                "[file_watch] Failed reading changed file",
+                extra={"file_path": file_path, "error": str(exc)},
+            )
+            notices.append(
+                ChangedFileNotice(
+                    file_path=file_path,
+                    summary=f"File changed but could not be read: {exc}",
+                )
+            )
+            # Avoid spamming repeated errors by updating timestamp.
+            snapshot.timestamp = current_mtime
+            cache[file_path] = snapshot
+            continue
+
+        diff_summary = _build_diff_summary(
+            snapshot.content, new_content, file_path, max_lines=max_diff_lines
+        )
+        notices.append(ChangedFileNotice(file_path=file_path, summary=diff_summary))
+        # Update snapshot so we only notify on subsequent changes.
+        record_snapshot(
+            file_path,
+            new_content,
+            cache,
+            offset=snapshot.offset,
+            limit=snapshot.limit,
+        )
+
+    return notices

ripperdoc/utils/git_utils.py

@@ -0,0 +1,274 @@
+"""Git utilities for Ripperdoc."""
+
+import subprocess
+from pathlib import Path
+from typing import Dict, List, Optional, Tuple
+import fnmatch
+
+
+def is_git_repository(path: Path) -> bool:
+    """Check if a directory is a git repository."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--is-inside-work-tree"],
+            cwd=path,
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+        return result.returncode == 0 and result.stdout.strip() == "true"
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return False
+
+
+def get_git_root(path: Path) -> Optional[Path]:
+    """Get the git root directory for a given path."""
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "--show-toplevel"],
+            cwd=path,
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+        if result.returncode == 0:
+            return Path(result.stdout.strip())
+        return None
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return None
+
+
+def read_gitignore_patterns(path: Path) -> List[str]:
+    """Read .gitignore patterns from a directory and its parent directories."""
+    patterns: List[str] = []
+    current = path
+
+    # Read .gitignore from current directory up to git root
+    git_root = get_git_root(path)
+
+    while current and (git_root is None or current.is_relative_to(git_root)):
+        gitignore_file = current / ".gitignore"
+        if gitignore_file.exists():
+            try:
+                with open(gitignore_file, "r", encoding="utf-8") as f:
+                    for line in f:
+                        line = line.strip()
+                        if line and not line.startswith("#"):
+                            patterns.append(line)
+            except (IOError, UnicodeDecodeError):
+                pass
+
+        # Also check for .git/info/exclude
+        git_info_exclude = current / ".git" / "info" / "exclude"
+        if git_info_exclude.exists():
+            try:
+                with open(git_info_exclude, "r", encoding="utf-8") as f:
+                    for line in f:
+                        line = line.strip()
+                        if line and not line.startswith("#"):
+                            patterns.append(line)
+            except (IOError, UnicodeDecodeError):
+                pass
+
+        if current.parent == current:  # Reached root
+            break
+        current = current.parent
+
+    # Add global gitignore patterns
+    global_gitignore = Path.home() / ".gitignore"
+    if global_gitignore.exists():
+        try:
+            with open(global_gitignore, "r", encoding="utf-8") as f:
+                for line in f:
+                    line = line.strip()
+                    if line and not line.startswith("#"):
+                        patterns.append(line)
+        except (IOError, UnicodeDecodeError):
+            pass
+
+    return patterns
+
+
+def parse_gitignore_pattern(pattern: str, root_path: Path) -> Tuple[str, Optional[Path]]:
+    """Parse a gitignore pattern and return (relative_pattern, root)."""
+    pattern = pattern.strip()
+
+    # Handle absolute paths
+    if pattern.startswith("/"):
+        return pattern[1:], root_path
+
+    # Handle patterns relative to home directory
+    if pattern.startswith("~/"):
+        home_pattern = pattern[2:]
+        return home_pattern, Path.home()
+
+    # Handle patterns with leading slash (relative to repository root)
+    if pattern.startswith("/"):
+        return pattern[1:], root_path
+
+    # Default: pattern is relative to the directory containing .gitignore
+    return pattern, None
+
+
+def build_ignore_patterns_map(
+    root_path: Path,
+    user_ignore_patterns: Optional[List[str]] = None,
+    include_gitignore: bool = True,
+) -> Dict[Optional[Path], List[str]]:
+    """Build a map of ignore patterns by root directory."""
+    ignore_map: Dict[Optional[Path], List[str]] = {}
+
+    # Add user-provided ignore patterns
+    if user_ignore_patterns:
+        for pattern in user_ignore_patterns:
+            relative_pattern, pattern_root = parse_gitignore_pattern(pattern, root_path)
+            if pattern_root not in ignore_map:
+                ignore_map[pattern_root] = []
+            ignore_map[pattern_root].append(relative_pattern)
+
+    # Add .gitignore patterns
+    if include_gitignore and is_git_repository(root_path):
+        gitignore_patterns = read_gitignore_patterns(root_path)
+        for pattern in gitignore_patterns:
+            relative_pattern, pattern_root = parse_gitignore_pattern(pattern, root_path)
+            if pattern_root not in ignore_map:
+                ignore_map[pattern_root] = []
+            ignore_map[pattern_root].append(relative_pattern)
+
+    return ignore_map
+
+
+def should_ignore_path(
+    path: Path, root_path: Path, ignore_map: Dict[Optional[Path], List[str]]
+) -> bool:
+    """Check if a path should be ignored based on ignore patterns."""
+    # Check against each root in the ignore map
+    for pattern_root, patterns in ignore_map.items():
+        # Determine the actual root to use for pattern matching
+        actual_root = pattern_root if pattern_root is not None else root_path
+
+        try:
+            # Get relative path from actual_root
+            rel_path = path.relative_to(actual_root).as_posix()
+        except ValueError:
+            # Path is not under this root, skip
+            continue
+
+        # For directories, also check with trailing slash
+        rel_path_dir = f"{rel_path}/" if path.is_dir() else rel_path
+
+        # Check each pattern
+        for pattern in patterns:
+            # Handle directory-specific patterns
+            if pattern.endswith("/"):
+                if not path.is_dir():
+                    continue
+                pattern_without_slash = pattern[:-1]
+                if fnmatch.fnmatch(rel_path, pattern_without_slash) or fnmatch.fnmatch(
+                    rel_path_dir, pattern
+                ):
+                    return True
+            else:
+                if fnmatch.fnmatch(rel_path, pattern) or fnmatch.fnmatch(rel_path_dir, pattern):
+                    return True
+
+    return False
+
+
+def get_git_status_files(root_path: Path) -> Tuple[List[str], List[str]]:
+    """Get tracked and untracked files from git status."""
+    tracked: List[str] = []
+    untracked: List[str] = []
+
+    if not is_git_repository(root_path):
+        return tracked, untracked
+
+    try:
+        # Get tracked files (modified, added, etc.)
+        result = subprocess.run(
+            ["git", "status", "--porcelain"],
+            cwd=root_path,
+            capture_output=True,
+            text=True,
+            timeout=10,
+        )
+
+        if result.returncode == 0:
+            for line in result.stdout.strip().split("\n"):
+                if line:
+                    status = line[:2].strip()
+                    file_path = line[3:].strip()
+
+                    # Remove quotes if present
+                    if file_path.startswith('"') and file_path.endswith('"'):
+                        file_path = file_path[1:-1]
+
+                    if status == "??":  # Untracked
+                        untracked.append(file_path)
+                    else:  # Tracked (modified, added, etc.)
+                        tracked.append(file_path)
+
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+
+    return tracked, untracked
+
+
+def get_current_git_branch(root_path: Path) -> Optional[str]:
+    """Get the current git branch name."""
+    if not is_git_repository(root_path):
+        return None
+
+    try:
+        result = subprocess.run(
+            ["git", "branch", "--show-current"],
+            cwd=root_path,
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+
+    return None
+
+
+def get_git_commit_hash(root_path: Path) -> Optional[str]:
+    """Get the current git commit hash."""
+    if not is_git_repository(root_path):
+        return None
+
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "HEAD"],
+            cwd=root_path,
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+        if result.returncode == 0:
+            return result.stdout.strip()[:8]  # Short hash
+    except (subprocess.SubprocessError, FileNotFoundError):
+        pass
+
+    return None
+
+
+def is_working_directory_clean(root_path: Path) -> bool:
+    """Check if the working directory is clean (no uncommitted changes)."""
+    if not is_git_repository(root_path):
+        return True
+
+    try:
+        result = subprocess.run(
+            ["git", "status", "--porcelain"],
+            cwd=root_path,
+            capture_output=True,
+            text=True,
+            timeout=5,
+        )
+        return result.returncode == 0 and not result.stdout.strip()
+    except (subprocess.SubprocessError, FileNotFoundError):
+        return True