prreview 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 700fa5c2803277c3047957a7ed81f605baaa2efebacb99c367331e3f88f866c5
-  data.tar.gz: 1bdf5fe31c583de5a81dd8a0fccbd5f7a5e02640a6c18ba8697c92bf086f8309
+  metadata.gz: 714f7802004de97bfd9e4defb9f447ad5b445ea77e12b8f04123218a6684549b
+  data.tar.gz: ce62752c1d1d11c13f432e0c74df032873088d75018a13dec4dfc658b5ed6c73
 SHA512:
-  metadata.gz: 3e4e769b47652d76c065185661d6593507d1225282ab713e3145a0dcfb6ec6160dec0410a78df1c3ecd7e049a799f673a29651959ff755b95e54f34d5281ce79
-  data.tar.gz: ab68d24845e6ac8677383bfdc971fea1b957942327ddf7b503f9558dec5593235d7e74391d986ce9698c4102409064e9b505ac6e3c9b7b0426dd9dfe019aef9c
+  metadata.gz: 7526eaadf9570e7ad2967a2e003989b3126bff0ae2d0907d4d4056f92b90f8e2e7dff91a17cef9cd8a6cd81625d20a0cf27dcb378a348f6e1f7708124952011f
+  data.tar.gz: b9a446c787e170bb3998211173e198d5cb67480512446ddbb9f0a7620a8233ec692f8493bed7c1e1b4a181968c8e6b1ee07f1a4838ddd515c300ef60ef18bddf

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:
@@ -44,10 +46,13 @@ However, in the future we might add some optional integrations.
 
 ## Tips
 
+- A well-written PR and linked issue description make a big difference — and are good practice anyway.
 - 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
 

data/lib/prreview/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prreview
-  VERSION = '0.2.0'
+  VERSION = '0.4.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,9 @@ module Prreview
     end
 
     def process
-      fetch_pull_request
-      fetch_issues
       load_optional_files
+      fetch_pull_request
+      fetch_linked_issues
       build_xml
       copy_result_to_clipboard
     end
@@ -48,26 +48,31 @@ module Prreview
     def parse_options!
       @prompt = DEFAULT_PROMPT
       @include_content = false
-      @issues_limit = DEFAULT_ISSUES_LIMIT
-      @optional_files  = []
+      @linked_issues_limit = DEFAULT_LINKED_ISSUES_LIMIT
+      @optional_files = []
+
+      ARGV << '--help' if ARGV.empty?
 
-      parser = OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} -u URL [options]"
+      OptionParser.new do |parser|
+        parser.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('-o', '--optional PATHS', 'Comma‑separated paths to local files (relative or absolute, e.g. docs/description.md,/etc/hosts)') do |v|
+        parser.on('-u', '--url URL', 'Pull‑request URL (https://github.com/owner/repo/pull/1)') { |v| @url = 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!
     end
 
     def parse_url!
@@ -84,11 +89,11 @@ 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'
+      abort 'Error: Invalid GITHUB_TOKEN.'
     end
 
     def fetch_pull_request
@@ -107,53 +112,50 @@ 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)
-      Base64.decode64(content[:content])
+      decoded = Base64.decode64(content[:content])
+      binary?(decoded) ? '(binary file)' : decoded
     rescue Octokit::NotFound
       '(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
 
@@ -171,11 +173,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)
       {
@@ -186,7 +188,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
 
@@ -194,6 +196,7 @@ module Prreview
       builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |x|
         x.prompt do
           x.task @prompt
+          x.current_date DateTime.now
 
           x.pull_request do
             x.number @pr_number
@@ -212,8 +215,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]
@@ -241,9 +244,13 @@ module Prreview
       @xml = builder.doc.root.to_xml
     end
 
+    def binary?(string)
+      string.include?("\x00")
+    end
+
     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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Evgenii Morozov