autogitc 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8338488482249d5ff2943379b1149b5da9db670f57821c6d827b1ba4b1c3f601
-  data.tar.gz: 271f9833f533852180a7598a0710006765a11b108a0d20d6876bb0b0985f81ce
+  metadata.gz: aba172777c4e300d27d6f4133ad6b06dee61e88a3df93bcb002c2f2201c5ca6b
+  data.tar.gz: b35eec122e676f8383f28c1ac797fbebe3388023738bb0b4177621f27c6d62d7
 SHA512:
-  metadata.gz: 7d182292cf4a0fe32fc1bb27e886a50a21a813a66902e07ee9557dbb6a6a3dc03f261723b2976414eddb990096f1cdaf3b4664cfb98c94e66d500cf96e8a0f1b
-  data.tar.gz: fcd92b63be81c3aae8b0678aea18b062cfffc5f070d18e280ce0133b59b44401d9f786fcccfefa41251d09f6a98add35f4c8614eb405264f3e6f18bdf2e41ac1
+  metadata.gz: '069a4f1e5db369d41f9498e5b6b731ef68877b0445d456f79c84023b8e188ac3538edf5c0489eaa2573c1a526221789d1b840efdebfd1fb8b2c81336a179f914'
+  data.tar.gz: f287b580a2c99637e39ce64191ef69f1495e6aae12e0d79665d75c18321f99f7ab3177658fd71e787eb3d2029f65817f16969006c365464a38edbac7d6529867

data/bin/autogitc

@@ -1,9 +1,19 @@
 #!/usr/bin/env ruby
 require 'bundler/setup'
-require_relative '../lib/autogitc'
+require_relative '../lib/commit_generator'
+require_relative '../lib/pr_template_generator'
 
-no_commit = ARGV.include?('--nocommit') || ARGV.include?('--nc')
-must_have_text = ARGV.find { |arg| arg.start_with?('--text=') }&.split('=')&.last
+if ARGV.include?('pr')
+  base_branch_arg = ARGV.find { |arg| arg.start_with?('--base=') }
+  base_branch = base_branch_arg ? base_branch_arg.split('=').last : 'main'
+  puts "Base branch not specified, defaulting to 'main'." if base_branch_arg.nil?
 
-puts 'Running autogitc...'
-Autogitc.main(no_commit: no_commit, must_have_text: must_have_text)
+  puts 'Running PR template generator...'
+  PrTemplateGenerator.main(base_branch: base_branch)
+else
+  no_commit = ARGV.include?('--nocommit') || ARGV.include?('--nc')
+  must_have_text = ARGV.find { |arg| arg.start_with?('--text=') }&.split('=')&.last
+
+  puts 'Running autogitc...'
+  CommitGenerator.main(no_commit: no_commit, must_have_text: must_have_text)
+end

data/lib/{autogitc.rb → commit_generator.rb}

@@ -1,8 +1,7 @@
-require 'net/http'
 require 'json'
-require 'uri'
+require_relative 'openai_wrapper'
 
-module Autogitc
+module CommitGenerator
   def self.openai_api_key
     ENV['AUTOGITC_KEY']
   end
@@ -16,20 +15,7 @@ module Autogitc
   end
 
   def self.generate_commit_message(changes_summary:, must_have_text: nil)
-    uri = URI('https://api.openai.com/v1/chat/completions')
-
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-
-    request = Net::HTTP::Post.new(
-      uri.path, {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{openai_api_key}"
-      }
-    )
-
-    request.body = {
-      model: 'gpt-4o-mini',
+    output = OpenAIWrapper.call_api(
       messages: [
         {
           role: 'system',
@@ -39,14 +25,9 @@ module Autogitc
           role: 'user',
           content: "Generate a conventional git commit message limited to 72 characters for the following changes in a JSON format with a key 'commit_message', ensuring it includes the text: '#{must_have_text}':\n\n#{changes_summary}"
         }
-      ],
-      response_format: { "type": 'json_object' }
-    }.to_json
-
-    response = http.request(request)
-    result = JSON.parse(response.body)
-    output_text = result.dig('choices', 0, 'message', 'content')
-    JSON.parse(output_text)['commit_message']
+      ]
+    )
+    JSON.parse(output)['commit_message']
   end
 
   def self.main(no_commit: false, must_have_text: nil)

data/lib/openai_wrapper.rb

@@ -0,0 +1,27 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+module OpenAIWrapper
+  def self.call_api(messages:, is_json_output: true)
+    uri = URI('https://api.openai.com/v1/chat/completions')
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    request = Net::HTTP::Post.new(
+      uri.path, {
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{ENV['AUTOGITC_KEY']}"
+      }
+    )
+
+    body = { model: 'gpt-4o-mini', messages: messages }
+    body.merge!(response_format: { "type": 'json_object' }) if is_json_output
+    request.body = body.to_json
+
+    response = http.request(request)
+    result = JSON.parse(response.body)
+    result.dig('choices', 0, 'message', 'content')
+  end
+end

data/lib/pr_template_generator.rb

@@ -0,0 +1,80 @@
+require 'json'
+require_relative 'openai_wrapper'
+
+module PrTemplateGenerator
+  # refer to https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
+  def self.template_paths
+    filename = 'pull_request_template.md'
+    [
+      File.join(Dir.pwd, filename),
+      File.join(Dir.pwd, 'docs', filename),
+      File.join(Dir.pwd, '.github', filename)
+    ]
+  end
+
+  def self.template_path_where_file_is_found
+    template_paths.each do |path|
+      return path if File.exist?(path)
+    end
+    nil
+  end
+
+  def self.output_path
+    File.join(Dir.pwd, "pull_request_template_#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}.md")
+  end
+
+  def self.branch_name
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+
+  def self.commits(base_branch:)
+    `git log --oneline #{base_branch}..HEAD`.strip
+  end
+
+  def self.template_content
+    File.read(template_path_where_file_is_found)
+  end
+
+  def self.generate_filled_template(base_branch:)
+    output = OpenAIWrapper.call_api(
+      messages: [
+        {
+          role: 'system',
+          content: 'You are a helpful assistant that generates filled pull request templates based on provided templates and context.'
+        },
+        {
+          role: 'user',
+          content: <<~PROMPT
+            Please fill out the following pull request template as closely as possible using the branch name '#{branch_name}' and the following commits:
+            #{commits(base_branch: base_branch)}
+
+            Template enclosed in ``` below:
+            ```
+            #{template_content}
+            ```
+
+            Ensure the output closely resembles the provided template.
+            Be succinct in the content.
+            Return only the filled template without any additional comments.
+          PROMPT
+        }
+      ],
+      is_json_output: false
+    )
+    output.strip.gsub(/^```|```$/, '')
+  end
+
+  def self.main(base_branch:)
+    if template_path_where_file_is_found.nil?
+      puts 'Pull request template not found.'
+      puts 'Template should be found at:'
+      template_paths.each { |path| puts " - #{path}" }
+      return
+    end
+
+    filled_template = generate_filled_template(base_branch: base_branch)
+
+    File.write(output_path, filled_template)
+    puts "Filled pull request template created at #{output_path}."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autogitc
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Adrian Goh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-28 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies: []
 description: This gem simplifies the commit process by automatically generating descriptive
   commit messages based on the files that have been added to the Git staging area.
@@ -21,7 +21,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/autogitc
-- lib/autogitc.rb
+- lib/commit_generator.rb
+- lib/openai_wrapper.rb
+- lib/pr_template_generator.rb
 homepage: https://github.com/adriangohjw/autogitc
 licenses:
 - MIT
@@ -34,7 +36,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="