autogitc 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99784fe2ee80335aad903a67b88543706b6c3674de445406a69f268fca38a543
-  data.tar.gz: 8c107ed10ed3c4d0f6776a0ae09d2c76c1d3b2e77dee7b144704a037e8413b3b
+  metadata.gz: 31e42a7e24a75eb40f81bebbb8f10736713b09e81eea160c8ec272b4db7f4ac4
+  data.tar.gz: 2d6baf30747d55b948565d59e4960b09cdc6d34cc9f48c3452377b8e5d294f9d
 SHA512:
-  metadata.gz: 3bd91f4c26f17dd0bf5414f47eba23f85f89d948b52843e4aad2daaf4fb0f527a39cc2504f66582760d3b3b70413db48b20f89a18dd13c4afb91e07c0f197e1c
-  data.tar.gz: 71abbc7d1dd108dfe140c183a828a1683e850488012fbda1f7ac408110c6e55683d7d5c54df30096ce3015e7baf70743cf1fbbf942417497128ac2cb6c314a7e
+  metadata.gz: fff1a7406f9b8068cc8540292d8ea66de54d18fc264cd6a6753e2c8f51e0c9785fe2a8194d9f618e9786d32cbc6e378c4cbc7b0124559be0335307fba8129eb7
+  data.tar.gz: 3aad6d08f82d07e339efe31b8bb4051a0c5d127d8993be9f87e75f396904002932c71c006af54deedd51dcf7e70ec6af0e7c26f9f568066f88981b16b595dab3

data/bin/autogitc

@@ -1,8 +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')
+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)
+  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
@@ -15,21 +14,8 @@ module Autogitc
     `git diff --staged #{file_path}`
   end
 
-  def self.generate_commit_message(changes_summary)
-    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',
+  def self.generate_commit_message(changes_summary:, must_have_text: nil)
+    output = OpenAIWrapper.call_api(
       messages: [
         {
           role: 'system',
@@ -37,19 +23,14 @@ 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':\n\n#{changes_summary}"
+          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)
+  def self.main(no_commit: false, must_have_text: nil)
     if openai_api_key.nil?
       puts 'No AUTOGITC_KEY key found in environment variables.'
       return
@@ -67,7 +48,10 @@ module Autogitc
       "Changes in #{file}:\n#{diff}\n"
     end.join("\n")
 
-    commit_message = generate_commit_message(changes_summary)
+    commit_message = generate_commit_message(
+      changes_summary: changes_summary,
+      must_have_text: must_have_text
+    )
     puts 'Generated commit message:'
     puts commit_message
 

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.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Goh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-08-31 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