nitpicker-code-review 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b493182d8ba98bc4e102c13f0a379eaf545f920f9cb4f72ce4b4a0db4d164d51
+  data.tar.gz: 285e6dd3c76d4a2a7d4df310d3618f058fd6e39335dd5d965b1155205376a399
+SHA512:
+  metadata.gz: eb1d96af03c6add163aca48519af15bbccc4ebc685d9d212b3cf52f925b345ff1bbd908c807f686e2e240e5d7075ee12f9e78dbf5ea45abb69d1da9b8ca91ad3
+  data.tar.gz: 54a486f87f322170dd2c0edfb41a225f5723f1507e8280f45d74dfd5a16026ed5a1a529a36eac3d08255c953ee2f076b760fc433e75d2272cc9c0a3c68d68fc8

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,201 @@
+# NitPicker
+
+NitPicker is a command-line tool that provides AI-powered code reviews for your Git changes. It analyzes your staged changes and offers constructive feedback to help improve code quality, security, performance, and maintainability.
+
+## Features
+
+- AI-powered code review of staged Git changes
+- Comprehensive analysis covering code quality, security, performance, and best practices
+- Customizable AI prompts for tailored review feedback
+- Support for repository-specific prompts
+- Choose any AI model (Google Gemini 2.5 Flash by default)
+- Easy integration into your Git workflow
+
+## Installation
+
+### Requirements
+
+- Ruby 2.6 or higher
+- Git
+
+### Option 1: Install as a Gem (Recommended)
+
+```bash
+gem install nitpicker-code-review
+```
+
+This automatically adds NitPicker to your PATH.
+
+### Option 2: Build and Install from Source
+
+Clone this repository:
+
+```bash
+git clone https://github.com/jubishop/NitPicker.git
+cd NitPicker
+```
+
+Build and install the gem:
+
+```bash
+gem build gemspec/nitpicker.gemspec
+gem install nitpicker-code-review-*.gem
+```
+
+### Option 3: Manual Installation
+
+Clone this repository:
+
+```bash
+git clone https://github.com/jubishop/NitPicker.git
+cd NitPicker
+```
+
+Make the script executable:
+
+```bash
+chmod +x bin/nitpicker
+```
+
+Create a symbolic link to make NitPicker available globally:
+
+```bash
+ln -s "$(pwd)/bin/nitpicker" /usr/local/bin/nitpicker
+```
+
+## Configuration
+
+### API Key Setup
+
+NitPicker requires an OpenRouter API key to generate code reviews. You need to set this as an environment variable:
+
+```bash
+export OPENROUTER_API_KEY="your_openrouter_api_key"
+```
+
+You can get an API key from [OpenRouter](https://openrouter.ai/).
+
+Optionally, you can specify a different model by setting:
+
+```bash
+export GIT_REVIEW_MODEL="openai/gpt-4o"
+```
+
+The default model is `google/gemini-2.5-flash-preview-05-20` if not specified.
+
+### Prompt Configuration
+
+NitPicker supports two levels of prompt configuration:
+
+- **Global Prompt (Default)**: Stored in `~/.config/nitpicker/prompt`. This is used for all repositories unless overridden.
+- **Repository-Specific Prompt**: Create a `.nitpicker_prompt` file in the root of your Git repository to customize the prompt for that specific project.
+
+When you run NitPicker, it will:
+- First look for a `.nitpicker_prompt` file in the root of the current Git repository
+- If not found, fall back to the global prompt at `~/.config/nitpicker/prompt`
+
+When you run NitPicker for the first time, if there's no global prompt file in the config directory, it will copy `config/prompt` to the config directory automatically.
+
+The special string `{{DIFF}}` in your prompt will be replaced with the current git diff of staged changes.
+
+## Usage
+
+Navigate to your Git repository, stage your changes, and run:
+
+```bash
+nitpicker [options]
+```
+
+Options:
+- `--version`: Show version information
+- `-h, --help`: Show help message
+
+## Examples
+
+```bash
+# Stage some changes first
+git add .
+
+# Get AI code review of staged changes
+nitpicker
+```
+
+Example output:
+```
+## Code Review Summary
+
+**Overall Assessment:** The changes look good with a few minor suggestions for improvement.
+
+### Positive Aspects:
+- Clean, readable code structure
+- Proper error handling implemented
+- Good variable naming conventions
+
+### Suggestions for Improvement:
+
+**Security:**
+- Consider validating user input on line 45 to prevent potential injection attacks
+
+**Performance:**
+- The database query on line 23 could be optimized by adding an index on the `user_id` column
+
+**Best Practices:**
+- Consider extracting the validation logic into a separate method for better reusability
+```
+
+## License
+
+MIT
+
+## Development
+
+### Project Structure
+
+NitPicker follows a specific project structure where all gemspec files and built gem files (.gem) are placed in the `gemspec/` folder rather than the root directory. This keeps the root directory clean and organized.
+
+### Rake Tasks
+
+NitPicker provides several rake tasks to streamline development:
+
+```bash
+# Run the test suite
+rake test
+
+# Build the gem and place it in the gemspec/ folder
+rake build
+
+# Build, install and test the gem
+rake install
+
+# Build and push the gem to RubyGems
+rake push
+```
+
+The default task is `rake test`.
+
+### Testing
+
+NitPicker uses Minitest for testing. To run the tests:
+
+```bash
+bundle install
+rake test
+```
+
+The test suite includes:
+- Unit tests for the CLI functionality
+- Tests for version consistency
+- Mock tests for API interactions (using WebMock)
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass
+6. Submit a pull request
+
+## Author
+
+Justin Bishop (jubishop)

data/bin/nitpicker

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This file is part of the standard gem pattern for executables.
+# When installed as a gem, RubyGems will create a wrapper script
+# that sets up the correct load path and then requires this file.
+
+# Add lib to the load path when running from source
+lib_dir = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'nitpicker'
+
+# Execute the CLI
+NitPicker::CLI.new.run

data/config/prompt

@@ -0,0 +1,39 @@
+You are an expert software engineer conducting a thorough code review. Analyze the following git diff and provide constructive feedback focusing on:
+
+**Code Quality & Best Practices:**
+- Code readability, maintainability, and organization
+- Adherence to language-specific conventions and idioms
+- Proper error handling and edge cases
+- Code duplication and refactoring opportunities
+
+**Security & Performance:**
+- Potential security vulnerabilities
+- Performance implications and optimization opportunities
+- Resource management and memory usage
+- Database query efficiency (if applicable)
+
+**Testing & Documentation:**
+- Test coverage for new functionality
+- Missing or inadequate documentation
+- API documentation and code comments
+
+**Architecture & Design:**
+- Design patterns and architectural consistency
+- Separation of concerns and modularity
+- Potential breaking changes or backwards compatibility
+
+**Specific Issues:**
+- Logic errors or bugs
+- Incorrect variable names or typos
+- Missing validation or sanitization
+- Hardcoded values that should be configurable
+
+Provide your feedback in a clear, constructive manner. For each issue identified:
+1. Explain the problem clearly
+2. Suggest specific improvements
+3. Explain why the change would be beneficial
+
+If the code looks good overall, highlight what was done well and provide any minor suggestions for improvement.
+
+DIFF:
+{{DIFF}}

data/lib/nitpicker/version.rb

@@ -0,0 +1,3 @@
+module NitPicker
+  VERSION = '1.0.0'
+end

data/lib/nitpicker.rb

@@ -0,0 +1,130 @@
+require 'nitpicker/version'
+require 'net/http'
+require 'uri'
+require 'json'
+require 'fileutils'
+require 'tmpdir'
+
+module NitPicker
+  class CLI
+    CONFIG_DIR = File.expand_path('~/.config/nitpicker')
+    PROMPT_FILE = File.join(CONFIG_DIR, 'prompt')
+    REPO_PROMPT_FILE = '.nitpicker_prompt'
+
+    def initialize
+      @options = {}
+      setup_config_dir
+    end
+
+    def parse_options
+      require 'optparse'
+      
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: nitpicker [options]'
+        opts.version = VERSION
+
+        opts.on('-h', '--help', 'Show this help message') do
+          puts opts
+          exit
+        end
+      end.parse!
+    end
+
+    def run
+      parse_options
+      
+      # Get git diff of staged changes
+      diff = `git diff --staged`
+      
+      if diff.empty?
+        puts "No changes staged for review."
+        exit 1
+      end
+
+      # Get AI-generated code review
+      review = generate_code_review(diff)
+      
+      # Display the review
+      puts review
+    end
+
+    private
+
+    def setup_config_dir
+      unless Dir.exist?(CONFIG_DIR)
+        FileUtils.mkdir_p(CONFIG_DIR)
+      end
+
+      unless File.exist?(PROMPT_FILE)
+        # Check for bundled prompt file in the config directory
+        config_prompt = File.join(File.dirname(__FILE__), '..', 'config', 'prompt')
+        
+        if File.exist?(config_prompt)
+          puts "Copying bundled prompt file to #{PROMPT_FILE}"
+          FileUtils.cp(config_prompt, PROMPT_FILE)
+          puts "Prompt file installed successfully."
+        else
+          puts "Error: Prompt file not found at #{PROMPT_FILE}"
+          puts "No bundled prompt file found at: #{config_prompt}"
+          puts "Please create a prompt file with your custom prompt."
+          exit 1 unless defined?(TESTING_MODE) && TESTING_MODE
+        end
+      end
+    end
+
+    def get_prompt
+      # First check for repository-specific prompt
+      if File.exist?(REPO_PROMPT_FILE)
+        return File.read(REPO_PROMPT_FILE)
+      end
+      
+      # Fall back to global prompt
+      File.read(PROMPT_FILE)
+    end
+
+    def generate_code_review(diff)
+      api_key = ENV['OPENROUTER_API_KEY']
+      if api_key.nil? || api_key.empty?
+        puts "Error: OPENROUTER_API_KEY environment variable not set"
+        exit 1
+      end
+
+      model = ENV['GIT_REVIEW_MODEL'] || 'google/gemini-2.5-flash-preview-05-20'
+      
+      prompt = get_prompt.gsub('{{DIFF}}', diff)
+      
+      uri = URI.parse('https://openrouter.ai/api/v1/chat/completions')
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Content-Type'] = 'application/json'
+      request['Authorization'] = "Bearer #{api_key}"
+      request['HTTP-Referer'] = 'https://github.com/nitpicker-code-review'
+      
+      request.body = {
+        model: model,
+        messages: [
+          { role: 'user', content: prompt }
+        ],
+        max_tokens: 2000
+      }.to_json
+      
+      begin
+        response = http.request(request)
+        
+        if response.code == '200'
+          result = JSON.parse(response.body)
+          review = result['choices'][0]['message']['content'].strip
+          return review
+        else
+          puts "API Error (#{response.code}): #{response.body}"
+          exit 1
+        end
+      rescue => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: nitpicker-code-review
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Justin Bishop
+bindir: bin
+cert_chain: []
+date: 2025-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: NitPicker is a command-line tool that uses AI to review your staged Git
+  changes and provide constructive feedback
+email:
+- jubishop@gmail.com
+executables:
+- nitpicker
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/nitpicker
+- config/prompt
+- lib/nitpicker.rb
+- lib/nitpicker/version.rb
+homepage: https://github.com/jubishop/NitPicker
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: AI-powered Git code review tool
+test_files: []