code-review-ai 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 44b987a9b718977db5cb57cc5070619c83527a885415ef390c1d816bfeadae2b
+  data.tar.gz: 175707830a53cba891cd74bd612cc6fb7e3efa3da3afeff59a5ddd2bc6607112
+SHA512:
+  metadata.gz: 95a4b53f801fed345232ee28aaca77ebbe7266ed154bc9c5ca4fd463b80e9a4bc2ed364d169a948c439f05c65f3735fff6adfc5112c84dcacb87c48704023027
+  data.tar.gz: a419729cc7f97749e220e453d8d80ad98bc96282950e3b9fd06cc366a3d1c66610c689a5108df0f8e1c9911e70c8d6a061e69c7e72a6a1f3f418add41d2f0097

data/bin/code-review-ai

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+require 'code_review_ai'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = <<~BANNER
+    Code Review AI - AI-powered code review tool
+
+    Usage: code-review-ai --command [review|summary] [options]
+
+    Commands:
+      review  - Conduct AI code review on current branch
+      summary - Generate branch change summary
+
+    Environment Variables:
+      OPENAI_ACCESS_TOKEN - OpenAI API key
+      OPENAI_MODEL        - AI model (default: gpt-3.5-turbo)
+      OPENAI_LANGUAGE     - Output language (default: English)
+  BANNER
+
+  opts.on("-k", "--api-key KEY", "OpenAI API key") do |key|
+    options[:api_key] = key
+  end
+
+  opts.on("-m", "--model MODEL", "AI model to use") do |model|
+    options[:model] = model
+  end
+
+  opts.on("-l", "--language LANG", "Language for output") do |lang|
+    options[:language] = lang
+  end
+
+  opts.on("-c", "--command CMD", "Command (review or summary)") do |cmd|
+    options[:command] = cmd
+  end
+end.parse!
+
+begin
+  api_key = options[:api_key] || ENV['OPENAI_ACCESS_TOKEN']
+  model = options[:model] || ENV['OPENAI_MODEL'] || 'gpt-3.5-turbo'
+  language = options[:language] || ENV['OPENAI_LANGUAGE'] || 'English'
+  command = options[:command] || 'review'
+
+  reviewer = CodeReviewAi::Client.new(api_key, model, language)
+
+  case command
+  when 'review'
+    reviewer.conduct_code_review
+  when 'summary'
+    puts reviewer.generate_branch_summary
+  else
+    puts "Unknown command. Use 'review' or 'summary'"
+    exit 1
+  end
+rescue StandardError => e
+  puts "Error: #{e.message}"
+  exit 1
+end

data/lib/code_review_ai/client/branch_summary.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require_relative '../prompts'
+
+module CodeReviewAi
+  class Client
+    def generate_branch_summary
+      prompt = generate_prompt(CodeReviewAi::Prompts::BRANCH_SUMMARY_TEMPLATE, @language)
+      response = @client.chat(
+        parameters: {
+          model: @ai_model,
+          messages: [
+            {
+              role: 'system',
+              content: 'You are an assistant summarizing git branch changes clearly and concisely.'
+            },
+            {
+              role: 'user',
+              content: prompt
+            }
+          ]
+        }
+      )
+      summary = process_response(response)
+      puts summary
+    rescue StandardError => e
+      "Error generating branch summary: #{e.message}"
+    end
+  end
+end

data/lib/code_review_ai/client/code_review.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+require_relative '../prompts'
+
+module CodeReviewAi
+  class Client
+    # Conduct an AI-powered code review on the current branch
+    # Analyzes git diff and generates review comments using OpenAI
+    #
+    # @return [String] Generated code review comments
+    def conduct_code_review
+      prompt = generate_prompt(CodeReviewAi::Prompts::CODE_REVIEW_TEMPLATE, @language)
+      response = @client.chat(
+        parameters: {
+          model: @ai_model,
+          messages: [
+            {
+              role: 'system',
+              content: 'You are an assistant generating code review comments based on repository changes.'
+            },
+            {
+              role: 'user',
+              content: prompt
+            }
+          ]
+        }
+      )
+      code_review_comments = process_response(response)
+      apply_code_review_comments(code_review_comments)
+    rescue StandardError => e
+      "Error communicating with OpenAI API: #{e.message}"
+    end
+  end
+end

data/lib/code_review_ai/client/initialize.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CodeReviewAi
+  class Client
+    # Initialize a new CodeReviewAi client
+    #
+    # @param api_token [String] OpenAI API access token for authentication
+    # @param ai_model [String] OpenAI model to use (e.g., 'gpt-3.5-turbo', 'gpt-4')
+    # @param language [String] Output language for generated content
+    def initialize(api_token, ai_model, language)
+      @client = create_openai_client(api_token)
+      @ai_model = ai_model
+      @language = language
+    end
+
+    private
+
+    def create_openai_client(api_token)
+      OpenAI::Client.new(
+        access_token: api_token,
+        log_errors: true
+      )
+    end
+  end
+end

data/lib/code_review_ai/client/utils.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module CodeReviewAi
+  class Client
+    private
+
+    def process_response(response)
+      response.dig('choices', 0, 'message', 'content') || 'Error: Unable to generate code review.'
+    end
+
+    def generate_prompt(template, language)
+      format(template, changes: fetch_branch_changes, language: language)
+    end
+
+    def fetch_branch_changes
+      current_branch = get_current_branch
+      default_branch = check_for_default_branch('main') || check_for_default_branch('master')
+
+      raise 'Neither main nor master branch found in the repository' unless default_branch
+      raise 'Could not determine current branch' unless current_branch
+
+      stdout, stderr, status = Open3.capture3("git diff #{default_branch}..#{current_branch}")
+
+      raise "Error getting git diff: #{stderr}" unless status.success?
+
+      stdout.strip
+    end
+
+    def check_for_default_branch(branch_name)
+      _, _, status = Open3.capture3("git show-ref refs/heads/#{branch_name}")
+      status.success? ? branch_name : nil
+    end
+
+    def get_current_branch
+      stdout, _, status = Open3.capture3('git rev-parse --abbrev-ref HEAD')
+      return stdout.strip if status.success?
+
+      nil
+    end
+
+    def apply_code_review_comments(code_review_comments)
+      comment_blocks = code_review_comments.scan(/File:\s+(.*?)\s+Line:\s+(\d+)\s+Suggestion:\s+(.*?)\s*(?:\n|$)/m)
+
+      comment_blocks.each do |file_path, line_number, suggestion|
+        add_comments_to_file(file_path, line_number.to_i, suggestion)
+      end
+    end
+
+    def add_comments_to_file(file_path, line_number, suggestion)
+      file_content = File.readlines(file_path)
+
+      # Ensure the line number is within the bounds of the file's length
+      if (1..file_content.size).cover?(line_number)
+        # Add the comment at the specified line
+        file_content[line_number - 1] = "#{file_content[line_number - 1].chomp} # #{suggestion}\n"
+        # Write the modified content back to the file
+        File.write(file_path, file_content.join)
+      else
+        puts "Warning: Line #{line_number} does not exist in file #{file_path}."
+      end
+    end
+  end
+end

data/lib/code_review_ai/prompts.rb

@@ -0,0 +1,52 @@
+module CodeReviewAi
+  module Prompts
+    CODE_REVIEW_TEMPLATE = <<~PROMPT
+      Act as a Ruby developer with expert-level knowledge of OOP principles and best practices.
+      You are tasked with reviewing the changes in the repository and providing ACTIONABLE code improvement suggestions.
+
+      I will specifiy the language(e.g., English) of the code review and provide the differences between the "current branch" and "main (or master)" branch at the end of this prompt.
+
+      Instructions for your response:
+
+      1. Carefully analyze the changes in terms of Object-Oriented Principles, performance, readability and maintainability, scalability, and error handling.
+      2. Provide improvement suggestions for each file and line number where applicable.
+      3. Use the exact format like below for every suggestion:
+
+      "File: lib/code_review_ai.rb  \nLine: 12  \nSuggestion: [👉SUGGESTION💡]Consider adding error handling for scenarios where the Git repository cannot be opened.\n\nFile: lib/code_review_ai.rb  \nLine: 24  \nSuggestion: [👉SUGGESTION💡]Add a comment to explain the purpose of the `generate_code_review` method.\n\nFile: lib/code_review_ai.rb  \nLine: 33  \nSuggestion: [👉SUGGESTION💡]Add a comment to clarify what the expected format of the prompt is.\n\nFile: lib/code_review_ai.rb  \nLine: 41  \nSuggestion: [👉SUGGESTION💡]Include a comment to describe what `apply_code_review_comments` does."
+
+      Ensure that each suggestion is clearly associated with the relevant file and line of code.
+      Make sure to FOLLOW THE FORMAT strictly to avoid any errors in processing the suggestions.
+
+      If code examples are available, make your best effort to include them in the suggestions.
+
+      Make sure NOT TO RETURN ANYTHING OUTSIDE OF THE REQUIRED FORMAT. No introduction or conclusion is needed.
+
+      Please generate the code review suggestions in following language:
+      %<language>s
+
+      Here are the changes in the repository:
+      %<changes>s
+    PROMPT
+
+    BRANCH_SUMMARY_TEMPLATE = <<~PROMPT
+      You are a Ruby developer with expert-level proficiency in OOP principles and best practices.
+      Your task is to provide a concise, well-structured summary of the changes made in the following branch.
+
+      Please ensure that all output is written in %<language>s.
+
+      Follow this format for your summary:
+
+      1. **Overview**: A high-level summary of the changes made in the branch, written in %<language>s.
+
+      2. **File-wise Breakdown**: For each file, list the key changes in bullet points. Be specific and concise:
+        - **Summary**: A brief description of the change.
+        - **Impact**: How the change affects the functionality or performance.
+        - **Potential Issues**: Any concerns or potential pitfalls with the change.
+        - **Suggestions for Improvement**: Recommendations for enhancing the change or code.
+        - **Other Notes**: Any additional relevant details or context.
+
+      Changes:
+      %<changes>s
+    PROMPT
+  end
+end

data/lib/code_review_ai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodeReviewAi
+  VERSION = '0.1.1'
+end

data/lib/code_review_ai.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'openai'
+require 'open3'
+require_relative 'code_review_ai/client/initialize'
+require_relative 'code_review_ai/client/code_review'
+require_relative 'code_review_ai/client/branch_summary'
+require_relative 'code_review_ai/client/utils'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: code-review-ai
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michiharu Ono
+bindir: bin
+cert_chain: []
+date: 2025-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: CLI tool that leverages OpenAI to generate code reviews
+email: michiharuono77@gmail.com
+executables:
+- code-review-ai
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/code-review-ai
+- lib/code_review_ai.rb
+- lib/code_review_ai/client/branch_summary.rb
+- lib/code_review_ai/client/code_review.rb
+- lib/code_review_ai/client/initialize.rb
+- lib/code_review_ai/client/utils.rb
+- lib/code_review_ai/prompts.rb
+- lib/code_review_ai/version.rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  After installing the gem, please run the following command to install Node.js dependencies:
+    npm install -g standard-version
+
+  You can then add a changelog by running:
+    npx standard-version --no-tag
+  This refers the version defined in the package.json file.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Generate code reviews effortlessly using OpenAI.
+test_files: []