n2b 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d512a4b43acc8a3adac6fe3fd60d05605abef697b36e0beb2e896371c6ae94c0
-  data.tar.gz: 140274359582046b03b89521d143e7efc498c07ee85c6cd200de821191b0b0db
+  metadata.gz: 0cad0de8d212180547279e2d92365d37ec44abeb716d6984a6770edc3067f963
+  data.tar.gz: 0d23a5f0841c06357175234129814ec2bb36b87d3106fd0e845a3d76fc37e559
 SHA512:
-  metadata.gz: '0184eb2ae93e21a1a389f7445c5e1d3532f645f5164df29ba7acc77ce67e163b8a273767aadc7a3b1ccab8483ae62d7e75b691331cb9145f4075a5a3aa3777ae'
-  data.tar.gz: d12e12c75dc2e6b161fb9f169de0a2dd7a8760bdcdf49b915c217407937516cffca31fb5649c5b65e33b81f7c02d688c7695c9c7cf4f5c638d837756c3ce97e5
+  metadata.gz: e348c724af4d838d64e86fbd78fa291a6bf10e585d501df061c5c88dae2e20bf7180bef645011057e458bd0226725ba51de230e7bb21b21927726b85f42453c3
+  data.tar.gz: 005d855b32744aa5b74694c4d2978c4bf2b21478d4a502e627b7cb0edb4abcb474bb18a50ab791c5b7155d040c59196f01fdb0ad1a7e3cabff5d7c88158bc168

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/n2b.svg)](https://badge.fury.io/rb/n2b)
 
-**Transform your development workflow with intelligent code analysis and seamless Jira integration.** N2B is an AI-powered development tool that revolutionizes code review, requirements compliance, and project management through automated analysis and smart ticket integration.
+**Transform your development workflow with intelligent code analysis and seamless Jira integration.** N2B is an AI-powered development tool that revolutionizes code review, requirements compliance, and project management through automated diff analysis, smart merge conflict resolution, and intelligent ticket integration.
 
 ## 🚀 **Key Features**
 
@@ -27,8 +27,45 @@
 - **Natural Language Commands**: Convert descriptions to executable bash commands
 - **Ruby Code Generation**: Generate Ruby code from natural language instructions
 - **VCS Integration**: Full Git and Mercurial support with branch comparison
+- **AI Merge Conflict Resolution**: Interactive merge conflict resolver with intelligent suggestions
 - **Errbit Integration**: Analyze errors and generate actionable reports
 
+## 🔍 **AI-Powered Diff Analysis** ⚡ *Beta Feature*
+
+**Get instant, intelligent code review for every change you make.** Our AI-powered diff analysis provides comprehensive insights into your code changes, helping you catch issues early and maintain high code quality.
+
+### ✨ **What Makes It Special**
+
+- **🧠 Context-Aware Analysis**: Understands your codebase patterns and architectural decisions
+- **🎯 Requirements Compliance**: Automatically checks if changes meet specified requirements
+- **🔍 Deep Code Review**: Identifies potential bugs, security issues, and performance problems
+- **💡 Smart Suggestions**: Provides actionable improvement recommendations with file/line references
+- **📊 Test Coverage**: Evaluates test completeness and suggests missing test scenarios
+- **🚀 Lightning Fast**: Get comprehensive analysis in seconds, not hours
+
+### 🚀 **Quick Start**
+
+```bash
+# Analyze your current changes
+n2b --diff
+
+# Compare against main branch with requirements checking
+n2b --diff --branch main --requirements requirements.md
+
+# Full workflow with Jira integration
+n2b --diff --jira PROJ-123 --jira-update
+```
+
+### 💬 **We Want Your Feedback!**
+
+This is a **beta feature** and we're actively improving it based on real-world usage. Your feedback is invaluable! Please share your experience:
+
+- 🐛 **Found a bug?** [Report it here](https://github.com/stefan-kp/n2b/issues)
+- 💡 **Have suggestions?** [Share your ideas](https://github.com/stefan-kp/n2b/discussions)
+- ⭐ **Love it?** [Star the repo](https://github.com/stefan-kp/n2b) and spread the word!
+
+---
+
 ## 🎯 **Jira Integration - Get Started in 2 Minutes**
 
 Transform your development workflow with intelligent Jira integration:
@@ -79,41 +116,132 @@ n2b --diff --branch main --requirements requirements.md
 n2b --diff --jira PROJ-123 --requirements specs.md
 ```
 
-## 🆕 **What's New in v0.5.0**
+## 🆕 **What's New in v0.7.1**
 
-- **🎯 Full Jira Integration**: Real API integration with ticket fetching and automated updates
-- **📝 Structured Comments**: Beautifully formatted Jira comments with collapsible sections
-- **🔍 Smart Requirements Extraction**: AI identifies requirements from tickets and comments
-- **🧪 Connection Testing**: Built-in `n2b-test-jira` utility for troubleshooting
-- **📋 Permission Validation**: Verifies all required Jira API permissions
-- **⚡ Enhanced Analysis**: Improved code review with better context and insights
+- **🔍 Enhanced AI Diff Analysis**: Comprehensive code review with context-aware insights (Beta)
+- **☐ Interactive Jira Checklists**: Native checkboxes for team collaboration and progress tracking
+- **🎯 Full Template Engine**: Variables, loops, conditionals for maximum customization
+- **🚨 Smart Error Classification**: Automatic severity detection (Critical/Important/Low)
+- **📁 Editor Integration**: Open conflicted files in your preferred editor with change detection
+- **🛡️ JSON Auto-Repair**: Automatically fixes malformed LLM responses
+- **✅ VCS Auto-Resolution**: Automatically marks resolved conflicts in Git/Mercurial
+- **🎨 Collapsible Sections**: Organized Jira comments with expand/collapse functionality
+- **🧪 Comprehensive Tests**: 103+ tests ensuring bulletproof reliability
+- **⚡ Enhanced Context**: Full file content sent to AI for better merge decisions
+- **🔄 Robust Error Handling**: Multiple recovery options when AI responses fail
 
 ## Installation
 
+### **Basic Installation**
+
 ```bash
 gem install n2b
 ```
 
-## Quick Start
+### **Global Installation with rbenv**
 
-### 🎯 **For Jira Users** (Most Popular)
+For users with rbenv (Ruby version manager), install globally to make n2b available across all Ruby versions:
 
 ```bash
-# Set up Jira integration
-n2b --advanced-config
+# Option 1: Install in system Ruby (Recommended)
+rbenv global system
+gem install n2b
+rbenv rehash
 
-# Analyze code changes against ticket
-n2b --diff --jira PROJ-123 --jira-update
+# Option 2: Install in a dedicated Ruby version
+rbenv install 3.3.0
+rbenv global 3.3.0
+gem install n2b
+rbenv rehash
+
+# Verify installation works across Ruby versions
+rbenv shell 3.1.0 && n2b --version
+rbenv shell 3.2.0 && n2b --version
 ```
 
-### 🔍 **For Code Review**
+### **Fix rbenv Shim Issues**
+
+If `n2b-diff` command is not found after installation:
 
 ```bash
-# AI-powered diff analysis
+# Remove corrupted shim and regenerate
+rm ~/.rbenv/shims/.rbenv-shim
+rm -rf ~/.rbenv/shims/*
+rbenv rehash
+
+# Verify both commands are available
+which n2b
+which n2b-diff
+```
+
+### **Configure as Default Merge Tool**
+
+#### **Git Integration**
+
+Add to your `~/.gitconfig`:
+
+```ini
+[merge]
+    tool = n2b-diff
+
+[mergetool "n2b-diff"]
+    cmd = n2b-diff "$MERGED"
+    trustExitCode = true
+    keepBackup = false
+```
+
+Usage:
+```bash
+git merge feature-branch
+# CONFLICT (content): Merge conflict in file.rb
+git mergetool  # Uses n2b-diff automatically
+```
+
+#### **Mercurial (hg) Integration**
+
+Add to your `~/.hgrc`:
+
+```ini
+[ui]
+merge = n2b-diff
+
+[merge-tools]
+n2b-diff.executable = n2b-diff
+n2b-diff.args = $output
+n2b-diff.premerge = keep
+n2b-diff.priority = 100
+```
+
+Usage:
+```bash
+hg merge
+# conflict in file.rb
+# n2b-diff launches automatically
+```
+
+## Quick Start
+
+### 🔍 **AI-Powered Code Review** (⚡ Beta - Try It Now!)
+
+```bash
+# Get instant AI analysis of your changes
 n2b --diff
 
-# Compare against main branch with requirements
+# Compare against main branch with requirements checking
 n2b --diff --branch main --requirements specs.md
+
+# Full workflow with Jira integration
+n2b --diff --jira PROJ-123 --jira-update
+```
+
+### 🎯 **For Jira Users** (Most Popular)
+
+```bash
+# Set up Jira integration
+n2b --advanced-config
+
+# Analyze code changes against ticket
+n2b --diff --jira PROJ-123 --jira-update
 ```
 
 ### 💻 **For Command Generation**
@@ -235,6 +363,24 @@ You can also set the history file location using the `N2B_HISTORY_FILE` environm
 export N2B_HISTORY_FILE=/path/to/your/history
 ```
 
+### Custom Prompt Templates
+
+N2B uses text templates for AI prompts. To override them, specify paths in your configuration:
+
+```yaml
+templates:
+  diff_system_prompt: /path/to/my_system_prompt.txt
+  diff_json_instruction: /path/to/my_json_instruction.txt
+  merge_conflict_prompt: /path/to/my_merge_prompt.txt
+```
+
+When these paths are not provided, the built-in templates located in `lib/n2b/templates/` are used.
+
+**Available Templates:**
+- `diff_system_prompt.txt` - Main diff analysis prompt
+- `diff_json_instruction.txt` - JSON formatting instructions for diff analysis
+- `merge_conflict_prompt.txt` - Merge conflict resolution prompt
+
 ## Quick Example N2B
 
 ```
@@ -332,8 +478,13 @@ Options:
 - `--jira-no-update`: Skip Jira ticket update (analyze only)
 - `-c` or `--config`: Reconfigure the tool
 - `--advanced-config`: Advanced configuration including Jira setup
+- `-v` or `--version`: Show version information
 - `-h` or `--help`: Display help information
 
+**Additional Commands:**
+- `n2b-diff FILE`: AI-powered merge conflict resolution
+- `n2b-test-jira`: Test Jira API connection and permissions
+
 Examples:
 
 1. Generate commands without executing:
@@ -442,13 +593,22 @@ You'll need:
 - **Email**: Your Jira account email
 - **API Token**: Generate from [Atlassian Account Settings](https://id.atlassian.com/manage-profile/security/api-tokens)
 
-### Required Jira Permissions
+### Required Jira API Scopes
+
+Your API token needs these specific scopes:
+
+**Essential Scopes:**
+- `read:project:jira` - View projects (access project list)
+- `read:issue:jira` - View issues (fetch ticket details)
+- `read:comment:jira` - View comments (fetch ticket comments for context)
+- `write:comment:jira` - Create and update comments (post analysis results)
 
-Your API token needs these permissions:
-- **Browse Projects** - Access project list
-- **Browse Issues** - Read ticket details
-- **View Comments** - Read ticket comments
-- **Add Comments** - Post analysis results
+**Optional but Recommended:**
+- `read:issue-details:jira` - View detailed issue information
+- `read:issue.property:jira` - View issue properties (comprehensive ticket data)
+
+**Legacy Permission Names (for older Jira versions):**
+- Browse Projects, Browse Issues, View Comments, Add Comments
 
 ### Usage
 
@@ -534,6 +694,190 @@ This will verify:
 - Required permissions
 - Specific ticket access (if provided)
 
+## 🔧 **AI-Powered Merge Conflict Resolution (n2b-diff)**
+
+Resolve Git and Mercurial merge conflicts with intelligent AI assistance.
+
+### Quick Start
+
+```bash
+# Resolve conflicts in a file
+n2b-diff conflicted_file.rb
+
+# With more context lines
+n2b-diff conflicted_file.rb --context 20
+
+# Get help
+n2b-diff --help
+```
+
+### How It Works
+
+1. **🔍 Detects Conflicts**: Automatically finds `<<<<<<<`, `=======`, `>>>>>>>` markers
+2. **📋 Extracts Context**: Shows surrounding code for better understanding
+3. **🤖 AI Analysis**: LLM analyzes both sides and suggests optimal merge
+4. **🎨 Interactive Review**: Colorized display with Accept/Skip/Comment/Abort options
+5. **✅ Applies Changes**: Updates file with accepted merges
+
+### Interactive Workflow
+
+For each conflict, you can:
+- **[y] Accept** - Apply the AI suggestion
+- **[n] Skip** - Keep the conflict as-is
+- **[c] Comment** - Add context to improve AI suggestions
+- **[a] Abort** - Stop processing and keep file unchanged
+
+### Features
+
+#### **🎨 Colorized Display**
+- 🔴 **Red**: Base/HEAD content (`<<<<<<< HEAD`)
+- 🟢 **Green**: Incoming content (`>>>>>>> feature`)
+- 🟡 **Yellow**: Conflict markers (`=======`)
+- 🔵 **Blue**: AI suggestions
+- ⚪ **Gray**: Reasoning explanations
+
+#### **🤖 Smart AI Analysis**
+- **Context Awareness**: Understands surrounding code patterns
+- **Quality Decisions**: Chooses enhanced implementations over simple ones
+- **Consistency**: Maintains coding patterns and architectural decisions
+- **User Feedback**: Incorporates comments to improve suggestions
+
+#### **⚙️ Configurable Options**
+- **Context Lines**: `--context N` (default: 10)
+- **Merge Logging**: Optional JSON logs in `.n2b_merge_log/`
+- **Custom Templates**: Configurable merge prompts
+
+### Example Session
+
+```bash
+$ n2b-diff user_service.rb
+
+<<<<<<< HEAD
+def create_user(name, email)
+  # Basic validation
+  raise "Invalid" if name.empty?
+  User.create(name: name, email: email)
+end
+=======
+def create_user(name, email, age = nil)
+  # Enhanced validation
+  validate_name(name)
+  validate_email(email)
+  User.create(name: name.titleize, email: email.downcase, age: age)
+end
+>>>>>>> feature/enhanced-validation
+
+--- Suggestion ---
+def create_user(name, email, age = nil)
+  # Enhanced validation with fallback
+  validate_name(name) if respond_to?(:validate_name)
+  validate_email(email) if respond_to?(:validate_email)
+  User.create(name: name.titleize, email: email.downcase, age: age)
+end
+
+Reason: Combined enhanced validation from feature branch with safety checks
+for method existence, maintaining backward compatibility while adding new features.
+
+Accept [y], Skip [n], Comment [c], Abort [a]: y
+```
+
+### Custom Templates
+
+Customize merge prompts by adding to your config:
+
+```yaml
+templates:
+  merge_conflict_prompt: /path/to/my_merge_prompt.txt
+```
+
+Template variables available:
+- `{full_file_content}` - Complete file content for full context understanding
+- `{context_before}` - Code before the conflict
+- `{context_after}` - Code after the conflict
+- `{base_label}` - Base branch label (e.g., "HEAD")
+- `{base_content}` - Base branch content
+- `{incoming_label}` - Incoming branch label (e.g., "feature/auth")
+- `{incoming_content}` - Incoming branch content
+- `{user_comment}` - User-provided comment (if any)
+
+### Use Cases
+
+- **Feature Branch Merges**: Resolve conflicts when merging feature branches
+- **Code Reviews**: Get AI assistance for complex merge decisions
+- **Refactoring**: Handle conflicts during large refactoring efforts
+- **Team Collaboration**: Standardize merge conflict resolution approaches
+- **Learning Tool**: Understand best practices for conflict resolution
+
+### **Daily Workflow Integration**
+
+#### **Git Workflow**
+```bash
+# During merge conflicts
+git merge feature-branch
+# CONFLICT (content): Merge conflict in file.rb
+
+# Use configured merge tool
+git mergetool
+
+# Or call directly
+n2b-diff file.rb
+
+# Continue merge
+git add file.rb
+git commit -m "Resolve merge conflicts"
+```
+
+#### **Mercurial Workflow**
+```bash
+# During hg merge conflicts
+hg merge
+# conflict in file.rb
+
+# Resolve with n2b-diff (auto-launches if configured)
+n2b-diff file.rb
+
+# Mark as resolved and commit
+hg resolve --mark file.rb
+hg commit -m "Resolve merge conflicts"
+```
+
+#### **Rebase Conflicts**
+```bash
+# Git rebase conflicts
+git rebase -i main
+# CONFLICT: Merge conflict in user_service.rb
+
+n2b-diff user_service.rb
+git add user_service.rb
+git rebase --continue
+```
+
+#### **Batch Conflict Resolution**
+```bash
+# Find and resolve all conflicts
+find . -name "*.rb" -exec grep -l "<<<<<<< HEAD" {} \; | while read file; do
+    echo "Resolving conflicts in $file"
+    n2b-diff "$file"
+done
+```
+
+#### **Shell Aliases for Convenience**
+Add to your `.zshrc` or `.bashrc`:
+```bash
+# Quick aliases for n2b tools
+alias resolve-conflicts='n2b-diff'
+alias test-jira='n2b-test-jira'
+alias ai-diff='n2b --diff'
+
+# Function to resolve all conflict files
+resolve-all-conflicts() {
+    find . -name "*.rb" -exec grep -l "<<<<<<< HEAD" {} \; | while read file; do
+        echo "Resolving conflicts in $file"
+        n2b-diff "$file"
+    done
+}
+```
+
 n2r in ruby or rails console
 n2r "your question", files:['file1.rb', 'file2.rb'], exception: AnError
 only question is mandatory
@@ -595,6 +939,13 @@ This project is licensed under the MIT License.
 
 ## Version History
 
+### 🔧 **v0.5.4 - AI-Powered Merge Conflict Resolver**
+- **NEW: n2b-diff command** - Interactive AI-powered merge conflict resolution
+- Colorized conflict display with Accept/Skip/Comment/Abort workflow
+- Smart AI suggestions with detailed reasoning and user feedback integration
+- Custom templates for merge prompts and configurable context lines
+- Merge logging and Git/Mercurial support
+
 ### 🚀 **v0.5.0 - Jira Integration & Enhanced Analysis**
 - Full Jira API integration with real ticket fetching and comment posting
 - Structured Jira comments using ADF with collapsible sections

data/bin/n2b-diff

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'n2b'
+
+N2B::MergeCLI.run(ARGV)

data/bin/n2b-test-jira

@@ -124,11 +124,11 @@ class JiraConnectionTester
     puts "3️⃣ Testing required permissions..."
 
     begin
-      # Test 1: Project access (Browse Projects permission)
+      # Test 1: Project access (read:project:jira scope)
       response = make_api_request('GET', '/project')
 
       if response.is_a?(Array) && response.length > 0
-        puts "   ✅ Browse Projects: Can access #{response.length} projects"
+        puts "   ✅ Project Access (read:project:jira): Can access #{response.length} projects"
         response.first(3).each do |project|
           puts "     - #{project['key']}: #{project['name']}"
         end
@@ -141,30 +141,30 @@ class JiraConnectionTester
         begin
           issues_response = make_api_request('GET', "/search?jql=project=#{test_project['key']}&maxResults=1")
           if issues_response['issues'] && issues_response['issues'].length > 0
-            puts "   ✅ Browse Issues: Can access issues in #{test_project['key']}"
+            puts "   ✅ Issue Access (read:issue:jira): Can access issues in #{test_project['key']}"
 
             # Test 3: Comment access (if we found an issue)
             test_issue = issues_response['issues'].first
             begin
               comments_response = make_api_request('GET', "/issue/#{test_issue['key']}/comment")
-              puts "   ✅ View Comments: Can access comments on #{test_issue['key']}"
+              puts "   ✅ Comment Access (read:comment:jira): Can access comments on #{test_issue['key']}"
             rescue => e
-              puts "   ❌ View Comments: Cannot access comments (#{e.message})"
+              puts "   ❌ Comment Access (read:comment:jira): Cannot access comments (#{e.message})"
             end
 
             # Test 4: Add comment permission (we won't actually add, just check the endpoint)
-            puts "   ℹ️  Add Comments: Will be tested when actually posting comments"
+            puts "   ℹ️  Comment Creation (write:comment:jira): Will be tested when actually posting comments"
           else
             puts "   ⚠️  No issues found in #{test_project['key']} to test comment permissions"
           end
         rescue => e
-          puts "   ❌ Browse Issues: Cannot search issues (#{e.message})"
+          puts "   ❌ Issue Access (read:issue:jira): Cannot search issues (#{e.message})"
         end
 
         puts
       else
-        puts "   ❌ Browse Projects: No projects accessible"
-        puts "   Your API token needs 'Browse Projects' permission"
+        puts "   ❌ Project Access: No projects accessible"
+        puts "   Your API token needs 'read:project:jira' scope"
         puts
       end
     rescue => e
@@ -173,11 +173,14 @@ class JiraConnectionTester
       puts
     end
 
-    puts "   📋 Required Jira Permissions for N2B:"
-    puts "   • Browse Projects - to access project list"
-    puts "   • Browse Issues - to read ticket details"
-    puts "   • View Comments - to read ticket comments"
-    puts "   • Add Comments - to post analysis results"
+    puts "   📋 Required Jira API Scopes for N2B:"
+    puts "   • read:project:jira - to access project list"
+    puts "   • read:issue:jira - to read ticket details"
+    puts "   • read:comment:jira - to read ticket comments"
+    puts "   • write:comment:jira - to post analysis results"
+    puts
+    puts "   📝 Legacy Permission Names (older Jira versions):"
+    puts "   • Browse Projects, Browse Issues, View Comments, Add Comments"
     puts
   end