pr_ai_gen 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d88c164cc0b3c276e43759573219cc064e5d141cd264d46e184bca12f02926b
-  data.tar.gz: 10041eea9b1b4465539cf00d260782692f84db5ea2347b8cbe5cc2bbdd725c57
+  metadata.gz: f4f268ae0b385a4fa49eeceaef9162bb365312e4fdbe0d10e2d7d4f524eeb7ba
+  data.tar.gz: af463bc198f734340918e3111218256c8f10ed5d0da04619b3d903d2190f66e4
 SHA512:
-  metadata.gz: dc88eee40aed632629dc2bdb1eb2fc2fa9ee5017b95a4f6c0dba9d2c9ca70d998563c020c6640766af70d57bdf6d74bf4412abe6d532730788e04e204f75d2fa
-  data.tar.gz: 553d015be904145afab53f9dde76bf605fe12d6d875ee5341522c18f637c84879c061e777c307edef44daba0a3c84dabff949153f37c29ede5c724812b1f5dce
+  metadata.gz: cc5fe7e238c9ee8277f74568b2e8cc3cba953b4dc4f95d6de559b5da547e93f7a4828e2f1d7a6ca4d73f23be09ece3b42e1df66ef5a9538f2b4bd5e851347d2e
+  data.tar.gz: 2c9eb8d5dbd3806a6132521e98f80cd4334c3d3ec879b094eef8fef67f347f8127fb912851b10a8343276ec8a33307319db488f098cc492742e2652e8d1f1133

data/Gemfile

@@ -2,8 +2,5 @@ source "https://rubygems.org"
 
 gem 'git'
 gem 'httparty'
-gem 'octokit'
-gem 'capybara'
-gem 'selenium-webdriver'
 gem 'optparse'
 gem 'pry'

data/Gemfile.lock

@@ -3,80 +3,34 @@ GEM
   specs:
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
-    base64 (0.2.0)
-    capybara (3.39.2)
-      addressable
-      matrix
-      mini_mime (>= 0.1.3)
-      nokogiri (~> 1.8)
-      rack (>= 1.6.0)
-      rack-test (>= 0.6.3)
-      regexp_parser (>= 1.5, < 3.0)
-      xpath (~> 3.2)
     coderay (1.1.3)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
     git (1.19.1)
       addressable (~> 2.8)
       rchardet (~> 1.8)
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    matrix (0.4.2)
     method_source (1.0.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
-    mini_mime (1.1.5)
     multi_xml (0.6.0)
-    nokogiri (1.15.5-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.15.5-x86_64-linux)
-      racc (~> 1.4)
-    octokit (8.1.0)
-      base64
-      faraday (>= 1, < 3)
-      sawyer (~> 0.9)
     optparse (0.4.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.4)
-    racc (1.7.3)
-    rack (3.0.9.1)
-    rack-test (2.1.0)
-      rack (>= 1.3)
     rchardet (1.8.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    ruby2_keywords (0.0.5)
-    rubyzip (2.3.2)
-    sawyer (0.9.2)
-      addressable (>= 2.3.5)
-      faraday (>= 0.17.3, < 3)
-    selenium-webdriver (4.9.0)
-      rexml (~> 3.2, >= 3.2.5)
-      rubyzip (>= 1.2.2, < 3.0)
-      websocket (~> 1.0)
-    websocket (1.2.10)
-    xpath (3.2.0)
-      nokogiri (~> 1.8)
 
 PLATFORMS
   arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
-  capybara
   git
   httparty
-  octokit
   optparse
   pry
-  selenium-webdriver
 
 BUNDLED WITH
    2.4.21

data/README.md

@@ -0,0 +1,37 @@
+# pr_ai_gen
+
+## Description
+
+pr_ai_gen is a CLI tool that acelerate the process of creating pull requests by Generate the PR description in markdown format.
+It uses OpenAI to generate the content based on the differences between the two git branches beeing merged.
+
+## Installation
+
+Install the gem by running:
+
+```bash
+gem install pr_ai_gen
+```
+
+### Setup
+
+```bash
+pr_ai_gen init
+```
+The tool will ask you to input the OPENAI_TOKEN to make the ChatGPT calls. If you don't have one, please generate one [here](https://platform.openai.com/api-keys).
+After input the token if you want to change it you can change it in `~/.pr_gem/credentials`.
+
+### Usage
+
+When the setup is already done you will be good to use the tool.
+
+Commands: 
+- `generate <directory_location> <branch>:<target-branch=main>`: Generate the PR description based on diff from the branch and target-branch (default main)
+
+## Development
+
+To develop you must:
+1. make the script in exe directory executable
+`chmod -x ./exe/pr_ai_gen`
+2. run the script directly as it is the cli tool
+`./exe/pr_ai_gen generate <directory_location> <branch>:<target-branch=main>`

data/lib/pull_request_ai_generator.rb

@@ -1,16 +1,12 @@
 require 'optparse'
 require 'git'
 require 'httparty'
-require 'octokit'
-require 'capybara/dsl'
 require 'pry'
 
 # Define the CLI class
 class PullRequestAIGenerator
   OPEN_AI_URL = "https://api.openai.com/v1"
 
-  include Capybara::DSL
-
   attr_reader :options
 
   def initialize(args)
@@ -18,10 +14,11 @@ class PullRequestAIGenerator
     @diff = nil
     @pr_content = nil
     @git_repo = nil
+    @config = nil
   end
 
   def init
-    puts 'Initializing pr-ai-gen...'
+    puts 'Initializing PR AI Generator...'
     credentials_path = File.expand_path('~/.pr-gem/credentials')
     pr_gem_path = File.expand_path('~/.pr-gem')
 
@@ -32,20 +29,49 @@ class PullRequestAIGenerator
 
     if File.exist?(credentials_path)
       puts 'Credentials file already exists!'
-      return
+    else
+      puts 'Please enter your OpenAI API key:'
+      openai_token = STDIN.gets.chomp
+      File.write(credentials_path, "OPENAI_TOKEN=#{openai_token}\n")
+      puts 'Credentials file created successfully!'
+    end
+
+    puts 'Configuring ChatGPT integration'
+    puts 'Please choose the OpenAI API model:'
+    puts '1. gpt-4-turbo-preview'
+    puts '2. gpt-4'
+    puts '3. gpt-3.5-turbo'
+    
+    model = nil
+    while model.nil?
+      case STDIN.gets.chomp
+      when '1'
+        model = 'gpt-4-turbo-preview'
+      when '2'
+        model = 'gpt-4'
+      when '3'
+        model = 'gpt-3.5-turbo'
+      else
+        puts 'Invalid model! Please choose a valid model:'
+      end
     end
 
-    puts 'Please enter your OpenAI API key:'
-    openai_token = STDIN.gets.chomp
-    File.write(credentials_path, "OPENAI_TOKEN=#{openai_token}\n")
-    puts 'Credentials file created successfully!'
+    config = {
+      openai: {
+        model: model,
+        max_tokens: 1024
+      }
+    }
+
+    File.write(File.join(pr_gem_path, 'config.yml'), config.to_yaml)
   end
 
   def run
-    puts 'Running pr-ai-gen...'
+    puts 'Running PR AI Generator...'
     fetch_diff
     load_template
     get_openai_token
+    get_config
     generate_pr_content
     print_content
   end
@@ -53,7 +79,17 @@ class PullRequestAIGenerator
   private
 
   def parse_options(args)
-    options = { target_branch: 'main', directory_location: File.expand_path("."), command: :run }
+    OptionParser.new do |opts|
+      opts.banner = "Usage: pr_ai_gen generate <directory_location> <branch>:<target-branch=main>"
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+
+    end.parse!(args)
+
+    options = { target_branch: 'main', directory_location: File.expand_path("."), command: :run } 
 
     if args[0] == 'init'
       options[:command] = :init
@@ -73,16 +109,6 @@ class PullRequestAIGenerator
       raise Exception.new "Invalid command!"
     end
 
-    OptionParser.new do |opts|
-      opts.banner = "Usage: pr-ai-gen <directory_location> <branch>:<target-branch=main>"
-
-      opts.on("-h", "--help", "Prints this help") do
-        puts opts
-        exit
-      end
-
-    end.parse!(args)
-
     options
   end
 
@@ -114,6 +140,15 @@ class PullRequestAIGenerator
     end
   end
 
+  def get_config
+    config_path = File.join(File.expand_path('~/.pr-gem'), 'config.yml')
+    if File.exist?(config_path)
+      @config = YAML.load_file(config_path)
+    else
+      raise "Config file not found!"
+    end
+  end
+
   def get_openai_token
     credentials_path = File.expand_path('~/.pr-gem/credentials')
     if File.exist?(credentials_path)
@@ -136,14 +171,14 @@ class PullRequestAIGenerator
         "Authorization" => "Bearer #{@openai_token}"
       },
       body: {
-        model: "gpt-4-turbo-preview",
+        model: @config[:openai][:model],
         messages: [
           {
             role: "user",
             content: "fill this templete:\n #{@template}\n with the following changes:\n #{@diff.to_s}"
           },
         ],
-        max_tokens: 1024
+        max_tokens: @config[:openai][:max_tokens]
       }.to_json
     )
 

data/pr_ai_gen.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "pr_ai_gen"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Lucas Stoller"]
   spec.email         = ["l.s.stoller@gmail.com"]
   spec.summary       = "A CLI tool to generate pull requests using OpenAI"
@@ -9,15 +9,11 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.bindir        = "exe"
-  spec.executables   = spec.executables = ['pr-ai-gen']
+  spec.executables   = spec.executables = ['pr_ai_gen']
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "git"
+  spec.add_dependency "git", "~> 1.19.1"
   spec.add_dependency "openai"
-  spec.add_dependency "octokit"
-  spec.add_dependency "capybara"
-  spec.add_dependency "selenium-webdriver"
-
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pr_ai_gen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lucas Stoller
@@ -14,16 +14,16 @@ dependencies:
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.19.1
 - !ruby/object:Gem::Dependency
   name: openai
   requirement: !ruby/object:Gem::Requirement
@@ -38,48 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: octokit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +71,15 @@ description: This tool automates the process of creating pull requests by using
 email:
 - l.s.stoller@gmail.com
 executables:
-- pr-ai-gen
+- pr_ai_gen
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
-- exe/pr-ai-gen
+- README.md
+- exe/pr_ai_gen
 - lib/pull_request_ai_generator.rb
 - pr_ai_gen.gemspec
 homepage: https://theright.dev