prreview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f2f069cb89df983a3f80577654a74fbafdf49d419a03f21ec1a2118d7cfa1c3
+  data.tar.gz: e55dc7c94887fa7f351b65f6ffa1fc50e9645635a3dac40bb83b3c69b9d75a8a
+SHA512:
+  metadata.gz: 70f1ff5e19ad21774e7314ef3d2c262e1f0807dd3a0d8c47c254f24bad4ab03ab225c0aaf6898b34ea4634dc72f2a8ca72cf943962472100bf32e7ec2ac07484
+  data.tar.gz: c03dc8a2def91204b92d47d74a3fb1b4b10558c83e8f396e19e69edab2a77165ea2d61c75189c0ca511728a0747bbcd4fc902f51a8db381e6deea4fe39fc84b7

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Evgenii Morozov
+
+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,31 @@
+## How to use
+
+Run this command with a PR URL:
+
+```sh
+bundle exec ruby prreview.rb --help
+bundle exec ruby prreview.rb -u https://github.com/evmorov/prreview/pull/2
+bundle exec ruby prreview.rb --url https://github.com/evmorov/prreview/pull/2 --all-content --prompt "Are there any security issues?"
+```
+
+Now, just paste the PR details into ChatGPT, Claude, or any LLM for review.
+
+## What it does
+
+PrReview collects key details about a PR, including:
+
+- PR description, commits, and comments
+- Linked issues
+- Changed files and their content
+- The full PR diff
+
+It then copies everything to your clipboard.
+
+## Requirements
+
+- Ruby
+- `GITHUB_TOKEN` environment variable
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/prreview

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Add the lib directory to the load path
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+
+require 'prreview'
+
+Prreview::CLI.new.process

data/lib/prreview/version.rb

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

data/lib/prreview.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require_relative 'prreview/version'
+
+require 'base64'
+require 'clipboard'
+require 'nokogiri'
+require 'octokit'
+require 'optparse'
+
+module Prreview
+  class CLI
+    DEFAULT_PROMPT = 'Your task is to review this pull request. Do you see any problems there?'
+    DEFAULT_ISSUES_LIMIT = 10
+
+    # url or owner/repo#123 or #123
+    URL_REGEX = %r{
+      https?://github\.com/
+        (?<owner>[\w.-]+) /
+        (?<repo>[\w.-]+) /
+        (?:pull|issues) /
+        (?<number>\d+)
+      |
+      (?:
+        (?<owner>[\w.-]+) /
+        (?<repo>[\w.-]+)
+      )?
+      \#
+      (?<number>\d+)
+    }x
+
+    def initialize
+      parse_options!
+      parse_url!
+      initialize_client
+    end
+
+    def process
+      fetch_pull_request
+      fetch_issues
+      build_xml
+      copy_result_to_clipboard
+    end
+
+    private
+
+    def parse_options!
+      @prompt = DEFAULT_PROMPT
+      @include_content = false
+      @issues_limit = DEFAULT_ISSUES_LIMIT
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} -u URL [options]"
+
+        opts.on('-u', '--url URL', 'Pull‑request URL (https://github.com/owner/repo/pull/1)') { |v| @url = v }
+        opts.on('-p', '--prompt PROMPT', 'Custom LLM prompt') { |v| @prompt = v }
+        opts.on('-a', '--all-content', 'Include full file contents') { @include_content = true }
+        opts.on('-l', '--limit LIMIT', Integer, "Limit number of issues fetched (default: #{DEFAULT_ISSUES_LIMIT})") { |v| @issues_limit = v }
+        opts.on('-h', '--help', 'Show help') do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!
+    end
+
+    def parse_url!
+      abort 'Error: Pull-request URL missing. Use -u or --url.' if @url.to_s.empty?
+
+      match = @url.match(URL_REGEX)
+      abort 'Error: Invalid URL format. See --help for usage.' unless match
+
+      @owner = match[:owner]
+      @repo = match[:repo]
+      @pr_number = match[:number].to_i
+      @full_repo = "#{@owner}/#{@repo}"
+    end
+
+    def initialize_client
+      access_token = ENV.fetch('GITHUB_TOKEN', nil)
+      abort 'Error: GITHUB_TOKEN is not set' if access_token.to_s.empty?
+
+      @client = Octokit::Client.new(access_token:, auto_paginate: true)
+    rescue Octokit::Unauthorized
+      abort 'Error: Invalid GITHUB_TOKEN'
+    end
+
+    def fetch_pull_request
+      puts "Fetching PR ##{@pr_number} for #{@full_repo}"
+
+      @pull_request = @client.pull_request(@full_repo, @pr_number)
+      @comments = @client.issue_comments(@full_repo, @pr_number).map(&:body)
+      @commits = @client.pull_request_commits(@full_repo, @pr_number).map { |c| c.commit.message }
+      @files = @client.pull_request_files(@full_repo, @pr_number).map do |file|
+        {
+          filename: file.filename,
+          patch: file.patch || '(no patch data)',
+          content: @include_content ? fetch_file_content(file.filename) : '(no content)'
+        }
+      end
+    end
+
+    def fetch_file_content(path)
+      puts "Fetching file content for #{path}"
+
+      content = @client.contents(@full_repo, path:, ref: @pull_request.head.sha)
+      Base64.decode64(content[:content])
+    rescue Octokit::NotFound
+      '(file content not found)'
+    end
+
+    def fetch_issues
+      @issues = []
+
+      text = [@pull_request.body, *@comments].join("\n")
+      queue = extract_refs(text, URL_REGEX)
+      seen = Set.new
+
+      until queue.empty? || @issues.length >= @issues_limit
+        ref = queue.shift
+        key = ref[:key]
+        next if seen.include?(key)
+
+        seen << key
+
+        issue = fetch_issue(ref)
+        next unless issue
+
+        @issues << issue
+
+        new_text = [issue[:description], *issue[:comments]].join("\n")
+        new_refs = extract_refs(new_text, URL_REGEX).reject { |nref| seen.include?(nref[:key]) }
+        queue.concat(new_refs)
+      end
+
+      puts "Fetched #{@issues.length} issues (limit: #{@issues_limit})"
+    end
+
+    def extract_refs(text, pattern)
+      text.to_enum(:scan, pattern).filter_map do
+        m = Regexp.last_match
+        next unless m[:number]
+
+        {
+          owner: m[:owner] || @owner,
+          repo: m[:repo] || @repo,
+          number: m[:number].to_i,
+          key: "#{m[:owner]}/#{m[:repo]}##{m[:number]}"
+        }
+      end
+    end
+
+    def fetch_issue(ref)
+      full_repo = "#{ref[:owner]}/#{ref[:repo]}"
+      number = ref[:number]
+
+      puts "Fetching issue ##{number} for #{full_repo}"
+
+      issue = @client.issue(full_repo, number)
+      {
+        full_repo:,
+        number:,
+        title: issue.title,
+        description: issue.body,
+        comments: @client.issue_comments(full_repo, number).map(&:body)
+      }
+    rescue Octokit::NotFound
+      puts "Issue #{number} for #{full_repo} not found, skipping"
+      nil
+    end
+
+    def build_xml
+      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |x|
+        x.prompt do
+          x.task @prompt
+
+          x.pull_request do
+            x.number @pr_number
+            x.title @pull_request.title
+            x.description @pull_request.body
+
+            @comments.each { |c| x.comment_ c }
+            @commits.each { |m| x.commit m }
+
+            @files.each do |file|
+              x.file do
+                x.filename file[:filename]
+                x.content file[:content]
+                x.patch file[:patch]
+              end
+            end
+          end
+
+          @issues.each do |issue|
+            x.issue do
+              x.repo issue[:full_repo]
+              x.number issue[:number]
+              x.title issue[:title]
+              x.description issue[:description]
+
+              issue[:comments].each { |c| x.comment_ c }
+            end
+          end
+
+          x.task @prompt
+        end
+      end
+
+      @xml = builder.doc.root.to_xml
+    end
+
+    def copy_result_to_clipboard
+      Clipboard.copy(@xml)
+      puts 'XML prompt generated and copied to clipboard.'
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: prreview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgenii Morozov
+- Iurii Alekseev
+- Quint
+bindir: exe
+cert_chain: []
+date: 2025-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: clipboard
+  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: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: PrReview collects PR data from GitHub (description, commits, comments,
+  linked issues, and code changes) and formats it as XML. Paste this XML into any
+  LLM like ChatGPT or Claude to get helpful code reviews.
+email:
+- evmorov@gmail.com
+- iurii.alekseev.inbox@gmail.com
+- quintgorssel@gmail.com
+executables:
+- prreview
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE
+- README.md
+- Rakefile
+- exe/prreview
+- lib/prreview.rb
+- lib/prreview/version.rb
+homepage: https://github.com/evmorov/prreview
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/evmorov/prreview
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.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: A CLI tool that formats GitHub PRs for LLM code reviews.
+test_files: []