prreview 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b817e16bf9a5637315d36b0dd477f851a80a03c1aa61988fdb521de6458dae
-  data.tar.gz: 44da1b71ce4de6cfe5ec280ee5eda07559ba28d2c5e9fcfda8a52fe30f9af899
+  metadata.gz: 9b7c0932a902f7945386447266e75f47c548440c6dba6f4df12120a7e1f798d8
+  data.tar.gz: 3ce6c0071493576b4a40763193797668206471b87d28a5d08ca74c37a720c0d9
 SHA512:
-  metadata.gz: 30d0092f74f555b89c2bc43c3badc141219c66b7f95c36e7084994ad3ed979abd997935454b141feb5ee72b20a0a75949b0260d062f84a04669f088592529369
-  data.tar.gz: cf0b141c62a2142417a784b42a9c9f323ec10406b378c5dfb998d53bc27a6245e0e8a4556a009e85510ca546a07462629d28d10a136da871f68dfa9336e53c70
+  metadata.gz: b549fb10017f52ee23154662ce1f28271f385e8771e607b9c736e2e5295327ff5389792bcdd4f6e55e9d490cc9e7ec2de04781bd4de4dc249865090e4d96d0d9
+  data.tar.gz: 8393b54c91c0c81dc8da1c9a7d7f39d864d455dd63b46ff4a7614783da90ff83554fc2a5daeca5aaee24b62ec54ecafb0d7c997ff5611a51db2355574f7596f0

data/.rubocop.yml

@@ -26,5 +26,8 @@ Metrics/CyclomaticComplexity:
 Metrics/ParameterLists:
   Enabled: false
 
+Metrics/PerceivedComplexity:
+  Enabled: false
+
 Naming/MethodParameterName:
   Enabled: false

data/lib/prreview/version.rb

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

data/lib/prreview.rb

@@ -10,7 +10,14 @@ require 'optparse'
 
 module Prreview
   class CLI
-    DEFAULT_PROMPT = 'Your task is to review this pull request. Do you see any problems there?'
+    DEFAULT_PROMPT = <<~PROMPT
+      Your task is to review this pull request.
+      Patch lines starting with `-` are deleted.
+      Patch lines starting with `+` are added.
+      Focus on new problems, not ones that were already there.
+      Do you see any problems?
+    PROMPT
+
     DEFAULT_LINKED_ISSUES_LIMIT = 5
 
     # url or owner/repo#123 or #123
@@ -38,7 +45,7 @@ module Prreview
     def process
       load_optional_files
       begin
-        fetch_pull_request
+        fetch_pr
         fetch_linked_issues
       rescue Octokit::Unauthorized
         abort 'Error: Invalid GITHUB_TOKEN.'
@@ -106,27 +113,24 @@ module Prreview
       @client = Octokit::Client.new(access_token:, auto_paginate: true)
     end
 
-    def fetch_pull_request
+    def fetch_pr
       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 && !skip_file?(file.filename) ? fetch_file_content(file.filename) : '(no content)'
-        }
-      end
+      @pr = @client.pull_request(@full_repo, @pr_number)
+      @pr_comments = @client.issue_comments(@full_repo, @pr_number)
+      @pr_code_comments = @client.pull_request_comments(@full_repo, @pr_number)
+      @pr_commits = @client.pull_request_commits(@full_repo, @pr_number)
+      @pr_files = @client.pull_request_files(@full_repo, @pr_number)
     end
 
     def fetch_file_content(path)
       puts "Fetching #{path}"
 
-      content = @client.contents(@full_repo, path:, ref: @pull_request.head.sha)
-      decoded = Base64.decode64(content[:content])
-      binary?(decoded) ? '(binary file)' : decoded
+      content = @client.contents(@full_repo, path:, ref: @pr.head.sha)
+      decoded = Base64.decode64(content.content)
+      return if binary?(decoded)
+
+      decoded
     rescue Octokit::NotFound
       '(file content not found)'
     end
@@ -134,7 +138,7 @@ module Prreview
     def fetch_linked_issues
       @linked_issues = []
 
-      text = [@pull_request.body, *@comments].join("\n")
+      text = [@pr.body, *@pr_comments.map(&:body), *@pr_code_comments.map(&:body)].join("\n")
       queue = extract_refs(text, URL_REGEX)
       seen = Set.new
 
@@ -145,12 +149,12 @@ module Prreview
 
         seen << key
 
-        issue = fetch_linked_issue(ref)
-        next unless issue
+        linked_issue = fetch_linked_issue(ref)
+        next unless linked_issue
 
-        @linked_issues << issue
+        @linked_issues << linked_issue
 
-        new_text = [issue[:description], *issue[:comments]].join("\n")
+        new_text = [linked_issue[:issue].body, *linked_issue[:comments].map(&:body)].join("\n")
         new_refs = extract_refs(new_text, URL_REGEX).reject { |nref| seen.include?(nref[:key]) }
         queue.concat(new_refs)
       end
@@ -174,65 +178,97 @@ module Prreview
         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]}"
-        }
+        owner = m[:owner] || @owner
+        repo = m[:repo] || @repo
+        number = m[:number].to_i
+        key = "#{owner}/#{repo}##{number}"
+
+        { owner:, repo:, number:, key: }
       end
     end
 
     def fetch_linked_issue(ref)
-      full_repo = "#{ref[:owner]}/#{ref[:repo]}"
+      issue_path = "#{ref[:owner]}/#{ref[:repo]}"
       number = ref[:number]
 
-      puts "Fetching linked issue ##{number} for #{full_repo}"
+      puts "Fetching linked issue ##{number} for #{issue_path}"
 
-      issue = @client.issue(full_repo, number)
       {
-        full_repo:,
-        number:,
-        title: issue.title,
-        description: issue.body,
-        comments: @client.issue_comments(full_repo, number).map(&:body)
+        issue: @client.issue(issue_path, number),
+        comments: @client.issue_comments(issue_path, number)
       }
     rescue Octokit::NotFound
-      warn "Linked issue #{number} for #{full_repo} not found, skipping"
+      warn "Linked issue #{number} for #{issue_path} 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.your_task @prompt
           x.current_date DateTime.now
 
           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 extract_patch(file)
+            build_issue!(x, @pr)
+
+            x.commits do
+              @pr_commits.each do |c|
+                x.commit do
+                  x.commiter c.committer&.login
+                  x.message c.commit.message
+                  x.date c.commit.committer&.date
+                end
+              end
+            end
+
+            x.comments do
+              @pr_comments.each do |c|
+                x.comment_ do
+                  build_comment!(x, c)
+                end
+              end
+            end
+
+            x.code_comments do
+              @pr_code_comments.each do |c|
+                x.code_comment do
+                  build_comment!(x, c)
+                  x.path c.path
+                  x.line c.line
+                end
+              end
+            end
+
+            x.pull_request_files do
+              @pr_files.each do |f|
+                content = fetch_file_content(f.filename) if @include_content && !skip_file?(f.filename)
+                patch = extract_patch(f)
+
+                x.file do
+                  x.filename f.filename
+                  x.content { cdata!(x, content) } if content
+                  x.patch { cdata!(x, patch) } if patch
+                end
               end
             end
           end
 
-          @linked_issues.each do |issue|
-            x.linked_issue do
-              x.repo issue[:full_repo]
-              x.number issue[:number]
-              x.title issue[:title]
-              x.description issue[:description]
+          x.linked_issues do
+            @linked_issues.each do |linked_issue|
+              issue = linked_issue[:issue]
+              comments = linked_issue[:comments]
 
-              issue[:comments].each { |c| x.comment_ c }
+              x.linked_issue do
+                build_issue!(x, issue)
+
+                x.comments do
+                  comments.each do |c|
+                    x.comment_ do
+                      build_comment!(x, c)
+                    end
+                  end
+                end
+              end
             end
           end
 
@@ -241,23 +277,38 @@ module Prreview
               @optional_file_contents.each do |file|
                 x.file do
                   x.filename file[:filename]
-                  x.content file[:content]
+                  x.content { cdata!(x, file[:content]) }
                 end
               end
             end
           end
 
-          x.task @prompt
+          # Intentionally duplicate the prompt to remind LLM about the task
+          x.your_task @prompt
         end
       end
 
       @xml = builder.doc.root.to_xml
     end
 
+    def build_issue!(xml, issue)
+      xml.url issue.html_url
+      xml.user issue.user.login
+      xml.title issue.title
+      xml.body issue.body
+      xml.created_at issue.created_at
+    end
+
+    def build_comment!(xml, comment)
+      xml.user comment.user.login
+      xml.body comment.body
+      xml.created_at comment.created_at
+    end
+
     def extract_patch(file)
-      return if skip_file?(file[:filename])
+      return if skip_file?(file.filename)
 
-      file[:patch]
+      file.patch
     end
 
     def skip_file?(filename)
@@ -268,6 +319,17 @@ module Prreview
       string.include?("\x00")
     end
 
+    def cdata!(x, str)
+      return unless str
+
+      parts = str.to_s.split(']]>')
+      x.cdata(parts.first || '')
+      parts.drop(1).each do |rest|
+        x.text(']]>')
+        x.cdata rest
+      end
+    end
+
     def copy_result_to_clipboard
       Clipboard.copy(@xml)
       puts 'XML prompt generated and copied to your clipboard.'

metadata

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