aicommit 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cea626b0f559f65a95e71bfdb301aefc9a43f6e9db7f527f6674a347f0f32146
-  data.tar.gz: a86134c702c388c4d1b03a59818fdc51f982fd9b7c5a9a22b11c58f98fb2b796
+  metadata.gz: 0cd5fd61fe0b6342c4a58f1f2c3e5bcb3a406cc3088df91772ab2a9b43716dd0
+  data.tar.gz: 2cecba681f7a7f4b83d5390d945aa33ecb54a539a2386f513b551669ef580cfe
 SHA512:
-  metadata.gz: b79282e1267f605a695130fe5cb9485db187058bf9f6de3c2e88eaba3a1f94ef68183790a166ec0db55e250a56369d2e71a77a248ac037d5973660f3027d4013
-  data.tar.gz: 6429a2aa883f599c74588a63e7c287bde92107a5bb3372fce8fc38bc9104e1cd0c0b552d61ba2e9c82630633227e445113e6e42c8b3944408b39c43d3554b9c1
+  metadata.gz: '08acb35449d5e7e78983d6f4f066cdbb31c9a2089a1d3adeed944ef7efbca95199eced51992c12c076dbebf2c19347da95807ce51ebc159b9425842a84ebc178'
+  data.tar.gz: 4b34a6394d6614f02c65d6cfe59858648921443a35de8e06d02c451be2fc60a19146f6a19a9f689e9b60177abf0a652ee34d6c7283a416d861f280aa3c964c16

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 EJ (YiJie)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Readme.md

@@ -0,0 +1,53 @@
+# AICommit
+Use your own spell against you.
+
+## Setup
+### Prerequisites
+- Ruby 2.5 or later
+- An OpenAI API key
+
+### Installation
+Install the aicommit gem:
+```bash
+gem install aicommit
+```
+### Upgrading
+To upgrade to the latest version of AICommit, run:
+
+```bash
+gem update aicommit
+```
+
+### Usage
+#### Generate a commit message
+To generate a commit message based on the changes in your Git repository:
+
+1. Run the following command at the root of your project:
+    ```bash
+    aicommit
+    ```
+
+2. The AI model will generate a commit message based on the changes in your Git repository.
+
+3. Review the generated commit message.
+
+4. To commit the changes with the generated commit message, enter Y at the prompt.
+To enter a new commit message, enter N.
+To quit without committing, enter Q.
+
+#### Uninstallation
+To uninstall AICommit, run:
+
+```bash
+gem uninstall aicommit
+```
+### How it works
+AICommit uses OpenAI's GPT-3.5 AI model to generate commit messages based on the changes in your Git repository.
+
+### Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+### License
+This project is licensed under the MIT License - see the LICENSE.md file for details.

data/bin/aicommit

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
 
-require "aicommit"
+require_relative "../lib/aicommit"
+
+Aicommit.new.run

data/lib/aicommit.rb

@@ -1,79 +1,61 @@
 require "git"
 require "openai"
-require "dotenv"
+require_relative "token_manager"
+require_relative "git_client"
+require_relative "commit_message_generator"
 
-Dotenv.load("#{File.expand_path("../..", __FILE__)}/.env")
-
-def save_api_key_to_env
-  puts "Please enter your OpenAI API key (or 'q' to quit):"
-  api_key = gets.chomp
-  if api_key.downcase == "q"
-    puts "Exiting program."
-    exit
+class Aicommit
+  def initialize
+    @token_manager = TokenManager.new
   end
 
-  File.write("#{File.expand_path("../..", __FILE__)}/.env", "OPENAI_API_KEY=#{api_key}")
-
-  Dotenv.overload!("#{File.expand_path("../..", __FILE__)}/.env")
-  puts "Your API key has been saved to .env"
-end
-
-def generate_commit_message(diff)
-  diff = diff[-3800..] || diff
-  client = OpenAI::Client.new(access_token: ENV["OPENAI_API_KEY"])
-  content = "Please generate a commit message based on the following diff in one sentance and less than 80 letters:\n#{diff}"
-
-  response = client.chat(
-    parameters: {
-      model: "gpt-3.5-turbo",
-      messages: [{role: "user", content: content}]
-    }
-  )
-
-  if response.code == 401
-    puts "Invalid API key."
-    save_api_key_to_env
-
-    return generate_commit_message(diff)
+  def run
+    patch_diffs = git_client.get_patch_str
+
+    commit_message = get_commit_message(patch_diffs)
+
+    loop do
+      puts "commit_message: #{commit_message}"
+      puts "Do you want to keep this commit_message? (Y/R/N) (or Q to quit)"
+      case gets.chomp
+      when /^[Yy]$/
+        git_client.commit_all(commit_message)
+        puts "Committed all changes with message: #{commit_message}"
+        exit
+      when /^[Rr]$/
+        puts "Regenerating..."
+        commit_message = get_commit_message(patch_diffs)
+      when /^[Nn]$/
+        puts "Please enter your new commit_message:"
+        commit_message = gets.chomp
+      when /^[Qq]$/
+        puts "Quit without committing."
+        exit
+      else
+        puts "Invalid command. Please enter Y, N, or Q."
+      end
+    end
   end
 
-  response.dig("choices", 0, "message", "content")
-end
+  private
 
-if !Dir.exist?(".git")
-  raise "Not a git repository!"
-end
-
-if ENV["OPENAI_API_KEY"].nil?
-  save_api_key_to_env
-end
-
-patch_str = ""
+  def get_commit_message(diff)
+    response = commit_message_generator.generate(diff)
+    if response[:code] == 401
+      puts "Invalid API key."
+      @token_manager.write!("OPENAI_API_TOKEN")
 
-git = Git.open(".")
-git.diff.each do |diff|
-  patch = diff.patch
-  patch_str += "\n\n#{diff.path}\n"
-  patch_str += patch
-end
+      get_commit_message(diff)
+    else
+      response[:result]
+    end
+  end
 
-commit_message = generate_commit_message(patch_str)
+  def git_client
+    @_git_client ||= GitClient.new
+  end
 
-loop do
-  puts "commit_message: #{commit_message}"
-  puts "Do you want to keep this commit_message? (Y/N) (or Q to quit)"
-  command = gets.chomp
-  if command.match?(/^[Yy]$/)
-    git.commit_all(commit_message)
-    puts "Committed all changes with message: #{commit_message}"
-    break
-  elsif command.match?(/^[Nn]$/)
-    puts "Please enter your new commit_message:"
-    commit_message = gets.chomp
-  elsif command.match?(/^[Qq]$/)
-    puts "Quit without committing."
-    exit
-  else
-    puts "Invalid command. Please enter Y, N, or Q."
+  def commit_message_generator
+    @_commit_message_generator = CommitMessageGenerator.new(@token_manager.fetch("OPENAI_API_TOKEN"))
   end
 end

data/lib/commit_message_generator.rb

@@ -0,0 +1,27 @@
+require "openai"
+
+class CommitMessageGenerator
+  def initialize(access_token)
+    @client = OpenAI::Client.new(access_token: access_token)
+  end
+
+  def generate(diff)
+    response = @client.chat(
+      parameters: {
+        model: "gpt-3.5-turbo",
+        messages: set_messages(diff)
+      }
+    )
+
+    {result: response.dig("choices", 0, "message", "content")&.strip, code: response.code}
+  end
+
+  private
+
+  def set_messages(diff)
+    diff = diff[-3800..] || diff
+    spell = "Please generate a commit message based on the following diff in one sentance and less than 80 letters: \n#{diff}"
+
+    [{role: "user", content: spell}]
+  end
+end

data/lib/git_client.rb

@@ -0,0 +1,41 @@
+class GitClient
+  def initialize
+    if !Dir.exist?(".git")
+      puts "Not a git repository!"
+      exit
+    end
+
+    @git = Git.open(".")
+  end
+
+  def get_patch_str
+    if current_branch.nil?
+      puts "No HEAD detected, please add your first commit, exiting program."
+      exit
+    end
+
+    patch_str = ""
+    @git.diff.each do |diff|
+      patch = diff.patch
+      patch_str += "\n\n#{diff.path}\n"
+      patch_str += patch
+    end
+
+    if patch_str.nil? || patch_str.strip.empty?
+      puts "No changes detected, exiting program."
+      exit
+    end
+
+    patch_str
+  end
+
+  def commit_all(message)
+    @git.commit_all(message)
+  end
+
+  private
+
+  def current_branch
+    @git.current_branch
+  end
+end

data/lib/token_manager.rb

@@ -0,0 +1,42 @@
+require "dotenv"
+
+class TokenManager
+  ENV_PATH = "#{File.expand_path("../..", __FILE__)}/.env".freeze
+
+  def initialize
+    Dotenv.load(ENV_PATH)
+  end
+
+  def fetch(key)
+    api_token = ENV[key]
+
+    if api_token.nil? || api_token.empty?
+      save_api_token_to_env!(key, gets_api_token)
+    else
+      api_token
+    end
+  end
+
+  def write!(key)
+    save_api_token_to_env!(key, gets_api_token)
+  end
+
+  private
+
+  def gets_api_token
+    puts "Please enter your OpenAI API token (or 'q' to quit):"
+    api_token = gets.chomp
+    if api_token.downcase == "q"
+      puts "Exiting program."
+      exit
+    end
+    api_token
+  end
+
+  def save_api_token_to_env!(key, api_token)
+    File.write(ENV_PATH, "#{key}=#{api_token}")
+    Dotenv.overload!(ENV_PATH)
+    puts "Your API token has been saved to .env"
+    api_token
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aicommit
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - jackal998
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-06 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -61,8 +61,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- Readme.md
 - bin/aicommit
 - lib/aicommit.rb
+- lib/commit_message_generator.rb
+- lib/git_client.rb
+- lib/token_manager.rb
 homepage: https://github.com/jackal998/aicommit
 licenses:
 - MIT