prreview 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af7fe1f1ccb8ef35c2eeec1252123861705106dc5439725923915ee20aa21fc6
-  data.tar.gz: 97c37aa978ee7df44aff01eaa890acc5bb2a60eacd17fceb7ad5cc4319f8aa1a
+  metadata.gz: 30200431f3796fe13f702beef779421ce9eb7cbb759bf05a781374d39dc4082b
+  data.tar.gz: cc6bbba926af7d7632a97d17551c045ead9b95b5e6682d988de20eef46d1f06b
 SHA512:
-  metadata.gz: 197d7fa53eda6c389cc68ff8eb97cb792e1704e4c808a74746bda25274194498a19b90cfbcd5b1dea89b5a7d7b16190790da198fba5571830ef902c0636e5b71
-  data.tar.gz: 680a13f38effb95f562898efd5b13baad3e6c16334ac2e37f783f4e8dec1ab4b86a3ada77a42b4cbe47c876340a946dd2c379361a36028ef5f2ac52d0bb28e7b
+  metadata.gz: 44622bc990c7059044df282588707f489814ab86c6b47eff1d64379809430061de7851d7f6455212a0f5155b76331538d0fc8fe366f9f18a56cf913e2487f9a0
+  data.tar.gz: e5281db6c13f7b36532e663cda11eeddc0bd540a598327e7e8e4a256b24addb1879f9758f4b2150c18a86e172a3e28e4c4989c31277c4297a3577dcc40e280bf

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
 
 Metrics/AbcSize:
   Enabled: false

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/prreview.svg)](https://badge.fury.io/rb/prreview)
+
 ## How to use
 
 Install:
@@ -9,14 +11,14 @@ gem install prreview
 Run this command with a PR URL:
 
 ```sh
-prreview -u https://github.com/owner/repo/pull/123
+prreview https://github.com/owner/repo/pull/123
 ```
 
 Or use more options:
 
 ```
 prreview --help
-prreview --url https://github.com/owner/repo/pull/123 --all-content --prompt "Are there any security issues?"
+prreview https://github.com/owner/repo/pull/123 --all-content --prompt "Are there any security issues?"
 ```
 
 Now, just paste the PR details into ChatGPT, Claude, or any LLM for review.
@@ -48,12 +50,15 @@ However, in the future we might add some optional integrations.
 - Run `prreview` after you've thoroughly reviewed the PR. It works best when you understand the changes well.
 - Don't hesitate to try different LLMs or refresh the response to see if something new comes up.
 - Use `--all-content` and other extra options — they can significantly improve results for some PRs.
-- After the LLM responds, ask "Anything else?" to potentially uncover more issues.
+- After the LLM responds, to potentially uncover more issues:
+  - Ask "Anything else?".
+  - If the response has a list of problems, try responding to each of them, giving the LLM more context.
 
 ## Requirements
 
 - Ruby
-- `GITHUB_TOKEN` environment variable
+- `GITHUB_TOKEN` environment
+  variable. [GitHub Docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
 
 ## License
 

data/lib/prreview/version.rb

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

data/lib/prreview.rb

@@ -11,7 +11,7 @@ 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
+    DEFAULT_LINKED_ISSUES_LIMIT = 5
 
     # url or owner/repo#123 or #123
     URL_REGEX = %r{
@@ -36,9 +36,15 @@ module Prreview
     end
 
     def process
-      fetch_pull_request
-      fetch_issues
       load_optional_files
+      begin
+        fetch_pull_request
+        fetch_linked_issues
+      rescue Octokit::Unauthorized
+        abort 'Error: Invalid GITHUB_TOKEN.'
+      rescue Octokit::NotFound
+        abort 'Error: Pull request not found.'
+      end
       build_xml
       copy_result_to_clipboard
     end
@@ -48,30 +54,41 @@ module Prreview
     def parse_options!
       @prompt = DEFAULT_PROMPT
       @include_content = false
-      @issues_limit = DEFAULT_ISSUES_LIMIT
+      @linked_issues_limit = DEFAULT_LINKED_ISSUES_LIMIT
       @optional_files = []
 
-      parser = OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} -u URL [options]"
+      ARGV << '--help' if ARGV.empty?
+
+      OptionParser.new do |parser|
+        parser.banner = <<~BAN
+          Usage: #{File.basename($PROGRAM_NAME)} URL [options]
+
+          Pull request URL example: https://github.com/owner/repo/pull/1
+
+        BAN
 
-        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('-o', '--optional PATHS', 'Comma‑separated paths to local files (relative or absolute, e.g. docs/description.md,/etc/hosts)') do |v|
+        parser.on('-p', '--prompt PROMPT', 'Custom LLM prompt') { |v| @prompt = v }
+        parser.on('-a', '--all-content', 'Include full file contents') { @include_content = true }
+        parser.on('-l', '--limit LIMIT', Integer, "Limit number of issues fetched (default: #{DEFAULT_LINKED_ISSUES_LIMIT})") { |v| @linked_issues_limit = v }
+        parser.on('-o', '--optional PATHS', 'Comma‑separated paths to local files (relative or absolute, e.g. docs/description.md,/etc/hosts)') do |v|
           @optional_files = v.split(',').map(&:strip)
         end
-        opts.on('-h', '--help', 'Show help') do
-          puts opts
+        parser.on_tail('-v', '--version', 'Show version') do
+          puts VERSION
           exit
         end
+        parser.on_tail('-h', '--help', 'Show help') do
+          puts parser
+          exit
+        end
+        parser.parse!
       end
 
-      parser.parse!
+      @url = ARGV.first
     end
 
     def parse_url!
-      abort 'Error: Pull-request URL missing. Use -u or --url.' if @url.to_s.empty?
+      abort 'Error: Pull request URL missing.' if @url.to_s.empty?
 
       match = @url.match(URL_REGEX)
       abort 'Error: Invalid URL format. See --help for usage.' unless match
@@ -84,11 +101,9 @@ module Prreview
 
     def initialize_client
       access_token = ENV.fetch('GITHUB_TOKEN', nil)
-      abort 'Error: GITHUB_TOKEN is not set' if access_token.to_s.empty?
+      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
@@ -107,7 +122,7 @@ module Prreview
     end
 
     def fetch_file_content(path)
-      puts "Fetching file content for #{path}"
+      puts "Fetching #{path}"
 
       content = @client.contents(@full_repo, path:, ref: @pull_request.head.sha)
       decoded = Base64.decode64(content[:content])
@@ -116,45 +131,41 @@ module Prreview
       '(file content not found)'
     end
 
-    def fetch_issues
-      @issues = []
+    def fetch_linked_issues
+      @linked_issues = []
 
       text = [@pull_request.body, *@comments].join("\n")
       queue = extract_refs(text, URL_REGEX)
       seen = Set.new
 
-      until queue.empty? || @issues.length >= @issues_limit
+      until queue.empty? || @linked_issues.length >= @linked_issues_limit
         ref = queue.shift
         key = ref[:key]
         next if seen.include?(key)
 
         seen << key
 
-        issue = fetch_issue(ref)
+        issue = fetch_linked_issue(ref)
         next unless issue
 
-        @issues << issue
+        @linked_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})"
+      puts "Fetched #{@linked_issues.length} linked issues (limit: #{@linked_issues_limit})"
     end
 
     def load_optional_files
       @optional_file_contents = @optional_files.filter_map do |path|
-        if File.exist?(path)
-          content = File.read(path)
-          { filename: path, content: content }
-        else
-          warn "File #{path} not found, skipping"
-          nil
-        end
+        puts "Reading #{path}"
+        abort "Optional file #{path} not found." unless File.exist?(path)
+        content = File.read(path)
+        { filename: path, content: }
       rescue StandardError => e
-        warn "Error reading file #{path}: #{e.message}"
-        nil
+        raise "Error reading file #{path}: #{e.message}"
       end
     end
 
@@ -172,11 +183,11 @@ module Prreview
       end
     end
 
-    def fetch_issue(ref)
+    def fetch_linked_issue(ref)
       full_repo = "#{ref[:owner]}/#{ref[:repo]}"
       number = ref[:number]
 
-      puts "Fetching issue ##{number} for #{full_repo}"
+      puts "Fetching linked issue ##{number} for #{full_repo}"
 
       issue = @client.issue(full_repo, number)
       {
@@ -187,7 +198,7 @@ module Prreview
         comments: @client.issue_comments(full_repo, number).map(&:body)
       }
     rescue Octokit::NotFound
-      puts "Issue #{number} for #{full_repo} not found, skipping"
+      warn "Linked issue #{number} for #{full_repo} not found, skipping"
       nil
     end
 
@@ -214,8 +225,8 @@ module Prreview
             end
           end
 
-          @issues.each do |issue|
-            x.issue do
+          @linked_issues.each do |issue|
+            x.linked_issue do
               x.repo issue[:full_repo]
               x.number issue[:number]
               x.title issue[:title]
@@ -249,7 +260,7 @@ module Prreview
 
     def copy_result_to_clipboard
       Clipboard.copy(@xml)
-      puts 'XML prompt generated and copied to clipboard.'
+      puts 'XML prompt generated and copied to your clipboard.'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prreview
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Evgenii Morozov