commit_ai 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2cbf31db80a94d89561081d2e035165821e0bfd7851f318c132900e9fcaad09
-  data.tar.gz: 571299591221bbf68455e1d5be5985797d6550d0aebfb0bdfc99427ebbeda914
+  metadata.gz: 43859139f57b17b863cc8b3f5a0ac1821bcde304f91071219b6ecef84b5ca3ff
+  data.tar.gz: fc3870e5b895d0a060bd39bd97f4eb6cabb32fe1ce30b39062dc3accc186e67a
 SHA512:
-  metadata.gz: 0d56d24e2629d896a83fc637128c04dca3fd0044e1b84ac34a4edc28a1b230c90280530324f0c980cfbc54b8c080c2e980cb933eaa2dab32e4bc0cf10bb7f1e0
-  data.tar.gz: 5d778db83320f38a912a984325777e27bab837a94deb0595dfe2cf3ebd57a38342501002deef4743a9452fc05252947f2269692394bea211201d8748de85415d
+  metadata.gz: f37fdd6fcf6420ef418cbf74832935e2c93409553d892e7a072c3521fa4fbae621ec786ff3d07c736aea064e87a5816b70e09359f4b28a81eeec78ead6898727
+  data.tar.gz: 3a7ede99534471bb07fc363c550c56ea917fd73b6d9251c670335327c63b99648b8cb521e4c4043e0bc5a231fb30252f8fcc063a84e80e7a373996e038d1b2ee

data/lib/commit_ai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommitAi
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/commit_ai.rb

@@ -5,42 +5,25 @@ class CommitAI
     @client = OpenAI::Client.new(access_token: ENV['OPENAI_ACCESS_TOKEN'])
   end
 
-  def generate_commit_message(diff)
-    prompt = <<~PROMPT
-      This is the git diff: #{diff}
-
-      Please generate a **single-line** commit message that is concise and follows best practices.
-      **Do not include any extra text or formatting** like triple backticks (```) or code block delimiters.
-      Only return the commit message.
-    PROMPT
-
-    response = @client.chat(
-      parameters: {
-        model: "gpt-3.5-turbo",
-        messages: [
-          { role: "system", content: "You are a git commit message generator for ruby on rails projects." },
-          { role: "user", content: prompt }
-        ],
-        max_tokens: 50,
-        temperature: 0.5
-      }
-    )
-
-    response.dig("choices", 0, "message", "content").strip
-  end
-
   def execute
     system("git add --all")
-    diff = `git diff --staged`
+    diff = `git diff -U99999 --staged`
 
     if diff.empty?
       puts "No changes to commit."
       return
     end
 
+    puts "Please provide a brief description of the change made (optional): "
+    user_description = STDIN.gets.chomp
+
+    puts "Do you want a multi-line commit message? (y/n) (optional): "
+    message_style_input = STDIN.gets.chomp.downcase
+    message_style = message_style_input == 'y' ? 'multi' : 'single'
+
     loop do
-      commit_message = generate_commit_message(diff)
-      puts "Generated Commit Message: #{commit_message}"
+      commit_message = generate_commit_message(diff, message_style, user_description)
+      puts "Generated Commit Message:\n#{commit_message}"
       print "Do you want to proceed with the commit? (y/n), regenerate (r), or edit (e): "
       response = STDIN.gets.chomp
       case response.downcase
@@ -58,4 +41,70 @@ class CommitAI
       end
     end
   end
+
+  private
+
+  def generate_commit_message(diff, message_style, user_description)
+    user_description_content = user_description.empty? ? '' : "Here is the user description of the change: \"#{user_description}\""
+    prompt = if message_style == 'single'
+               <<~PROMPT
+                 This is the git diff: #{diff}
+
+                 A git diff shows the changes made in a commit, where lines prefixed with a '+' indicate additions and lines prefixed with a '-' indicate deletions.
+
+                 #{user_description_content}
+
+                 Please generate a **single-line** commit message that is concise and follows best practices based on both the diff and user description.
+                 **Do not include any extra text or formatting** like triple backticks (```) or code block delimiters.
+                 Only return the commit message.
+               PROMPT
+             else
+               <<~PROMPT
+                 This is the git diff: #{diff}
+
+                 A git diff shows the changes made in a commit, where lines prefixed with a '+' indicate additions and lines prefixed with a '-' indicate deletions.
+
+                 #{user_description_content}
+
+                 Please generate a **multi-line** commit message that is clear, concise, and follows best practices based on both the diff and user description.
+                 The first line should be a short summary of the change.
+                 The second line should be blank.
+                 The following lines should provide additional details about the change and its purpose.
+               PROMPT
+             end
+
+    response = @client.chat(
+      parameters: {
+        model: "gpt-3.5-turbo",
+        messages: [
+          { role: "system", content: "You are a highly experienced senior software engineer specializing in Ruby on Rails projects. Your only task is to generate clear and concise git commit messages following best practices." },
+          { role: "user", content: prompt }
+        ],
+        max_tokens: 150,
+        temperature: 0.5
+      }
+    )
+
+    response.dig("choices", 0, "message", "content").strip
+  end
+
+  def minify_diff(diff, context_lines = 3)
+    minified_diff = []
+    current_context = []
+
+    diff.lines.each do |line|
+      if line.start_with?('+', '-')
+        # Add the surrounding context before and after changes
+        minified_diff.concat(current_context.last(context_lines))
+        minified_diff << line
+        current_context.clear  # Clear after using context lines
+      else
+        # Only keep a limited number of context lines
+        current_context << line unless line.strip.empty?
+        current_context = current_context.last(context_lines)  # Trim extra lines
+      end
+    end
+
+    minified_diff.join
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commit_ai
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ken Vitug
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-04 00:00:00.000000000 Z
+date: 2024-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,8 +24,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Commit AI automates the generation of insightful one-liner commit messages
-  by analyzing staged git diffs with the help of OpenAI's advanced language models.
+description: Commit AI automates the generation of insightful single-line and multi-line
+  commit messages by analyzing staged git diffs with OpenAI's advanced language models.
+  It allows users to provide optional change descriptions for better context, and
+  smartly minifies the git diff to focus on the essential changes, ensuring clarity
+  and best practices.
 email:
 - ken@narralabs.com
 executables:
@@ -63,5 +66,5 @@ rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby gem that utilizes OpenAI to create concise and meaningful commit messages
-  based on the differences in your git changes.
+  based on staged git changes.
 test_files: []