prreview 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f2f069cb89df983a3f80577654a74fbafdf49d419a03f21ec1a2118d7cfa1c3
-  data.tar.gz: e55dc7c94887fa7f351b65f6ffa1fc50e9645635a3dac40bb83b3c69b9d75a8a
+  metadata.gz: af7fe1f1ccb8ef35c2eeec1252123861705106dc5439725923915ee20aa21fc6
+  data.tar.gz: 97c37aa978ee7df44aff01eaa890acc5bb2a60eacd17fceb7ad5cc4319f8aa1a
 SHA512:
-  metadata.gz: 70f1ff5e19ad21774e7314ef3d2c262e1f0807dd3a0d8c47c254f24bad4ab03ab225c0aaf6898b34ea4634dc72f2a8ca72cf943962472100bf32e7ec2ac07484
-  data.tar.gz: c03dc8a2def91204b92d47d74a3fb1b4b10558c83e8f396e19e69edab2a77165ea2d61c75189c0ca511728a0747bbcd4fc902f51a8db381e6deea4fe39fc84b7
+  metadata.gz: 197d7fa53eda6c389cc68ff8eb97cb792e1704e4c808a74746bda25274194498a19b90cfbcd5b1dea89b5a7d7b16190790da198fba5571830ef902c0636e5b71
+  data.tar.gz: 680a13f38effb95f562898efd5b13baad3e6c16334ac2e37f783f4e8dec1ab4b86a3ada77a42b4cbe47c876340a946dd2c379361a36028ef5f2ac52d0bb28e7b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -1 +1 @@
-3.4.1
+3.4.3

data/README.md

@@ -1,11 +1,22 @@
 ## How to use
 
+Install:
+
+```sh
+gem install prreview
+```
+
 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?"
+prreview -u 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?"
 ```
 
 Now, just paste the PR details into ChatGPT, Claude, or any LLM for review.
@@ -21,6 +32,24 @@ PrReview collects key details about a PR, including:
 
 It then copies everything to your clipboard.
 
+## Why prompt
+
+Advantages over LLM integrations:
+
+- You're free to use the LLM of your choice
+- You can continue the conversation with the LLM right in the chat, asking to pay attention to a specific part of the PR
+- The gem is simpler
+
+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.
+
 ## Requirements
 
 - Ruby

data/lib/prreview/version.rb

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

data/lib/prreview.rb

@@ -38,6 +38,7 @@ module Prreview
     def process
       fetch_pull_request
       fetch_issues
+      load_optional_files
       build_xml
       copy_result_to_clipboard
     end
@@ -48,6 +49,7 @@ module Prreview
       @prompt = DEFAULT_PROMPT
       @include_content = false
       @issues_limit = DEFAULT_ISSUES_LIMIT
+      @optional_files = []
 
       parser = OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} -u URL [options]"
@@ -56,6 +58,9 @@ module Prreview
         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|
+          @optional_files = v.split(',').map(&:strip)
+        end
         opts.on('-h', '--help', 'Show help') do
           puts opts
           exit
@@ -105,7 +110,8 @@ module Prreview
       puts "Fetching file content for #{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
@@ -137,6 +143,21 @@ module Prreview
       puts "Fetched #{@issues.length} issues (limit: #{@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
+      rescue StandardError => e
+        warn "Error reading file #{path}: #{e.message}"
+        nil
+      end
+    end
+
     def extract_refs(text, pattern)
       text.to_enum(:scan, pattern).filter_map do
         m = Regexp.last_match
@@ -174,6 +195,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
@@ -203,6 +225,17 @@ module Prreview
             end
           end
 
+          unless @optional_file_contents.empty?
+            x.local_context_files do
+              @optional_file_contents.each do |file|
+                x.file do
+                  x.filename file[:filename]
+                  x.content file[:content]
+                end
+              end
+            end
+          end
+
           x.task @prompt
         end
       end
@@ -210,6 +243,10 @@ 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.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prreview
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Evgenii Morozov
@@ -9,7 +9,7 @@ authors:
 - Quint
 bindir: exe
 cert_chain: []
-date: 2025-05-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -93,6 +93,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - LICENSE
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A CLI tool that formats GitHub PRs for LLM code reviews.
 test_files: []