ai_git_commit 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b14c761a09946ac7dccecc9a2b30c3926d4b8607de3cc030faefaf3c39341abf
+  data.tar.gz: 389310ce83fe9f84928c8fe6cfd25e89cd79f84b73825fadca71f3f39c800ba0
+SHA512:
+  metadata.gz: 6ec4e82fd7e052996c45d1f9066cef2f7d3f0e54c8d8809bd0e89841026acc34e7b622cc6d11315aea333c61976da8a3f6f804634787ce03abeac58717ac6745
+  data.tar.gz: f24abb2d10dd6453c921d86de3b802de709e77cb01f66a51220db80d8d6c11ba86783cf4e2f1053f9d0e9cf7e4ad359c0615930b1c8e430635db77272d5d6b57

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - 'exe/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'ai_git_commit.gemspec'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mike Belyaev
+
+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,42 @@
+# AiGitCommit
+
+AiGitCommit is a Ruby gem designed to help automate and enhance your git commit workflow using AI.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ai_git_commit
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ai_git_commit
+```
+
+then run to install it:
+
+```bash
+ai_git_commit install
+```
+
+## Usage
+
+All you have to do is to have a `OPENAI_API_KEY` environment variable set with your OpenAI API key.
+
+Then, just:
+```bash
+git add <files>
+git commit
+```
+That's it! Your commit message will be generated by AI.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drkmen/ai_git_commit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/ai_git_commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "ai_git_commit/cli"
+AiGitCommit::CLI.start(ARGV)

data/lib/ai_git_commit/cli.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "thor"
+require "fileutils"
+
+module AiGitCommit
+  # CLI class provides command-line interface for AI Git Commit tool.
+  # It uses Thor for command parsing and execution.
+  class CLI < Thor
+    HOOK_PATH = ".git/hooks/prepare-commit-msg"
+
+    # Installs the prepare-commit-msg hook.
+    # If the hook already exists, appends the script; otherwise, creates a new hook file.
+    # Makes the hook executable and prints a confirmation message.
+    desc "install", "Set up prepare-commit-msg hook"
+    def install
+      create_hook
+      copy_initializer
+      puts "AI Git Commit prepare-commit-msg hook set up."
+    end
+
+    private
+
+    # Creates or updates a Git hook file with a given script.
+    # If the hook file already exists, it appends the script to it.
+    # Otherwise, it creates a new file with the script content.
+    # Finally, it sets the file's permissions to be executable.
+    # @return [void]
+    def create_hook
+      if hook_file_exists?
+        File.open(HOOK_PATH, "a") { _1.puts script }
+      else
+        File.write(HOOK_PATH, script)
+      end
+      FileUtils.chmod("+x", HOOK_PATH)
+    end
+
+    # Copies the ai_git_commit initializer template into the application's config directory.
+    # This ensures that:
+    # * The destination directory (config/initializers) exists
+    # * The initializer file (ai_git_commit.rb) is copied from the templates directory
+    # @return [void]
+    def copy_initializer
+      source = File.expand_path("../templates/ai_git_commit.rb", __dir__)
+      destination_dir = File.expand_path("config/initializers", Dir.pwd)
+      destination = File.join(destination_dir, "ai_git_commit.rb")
+      FileUtils.mkdir_p(destination_dir)
+      FileUtils.cp(source, destination)
+    end
+
+    # The script content for the prepare-commit-msg hook.
+    # Adds a shebang line if the hook file does not exist.
+    # The script runs a Ruby command to generate a commit message using AiGitCommit::Generator.
+    # @return [String] the script content
+    def script
+      <<~SCRIPT
+        #{"#!/bin/bash" unless hook_file_exists?}
+        ruby -r 'ai_git_commit' -e 'puts AiGitCommit::Generator.commit_message' >> .git/COMMIT_EDITMSG
+      SCRIPT
+    end
+
+    # Checks if the prepare-commit-msg hook file exists.
+    # @return [Boolean] true if the hook file exists, false otherwise.
+    def hook_file_exists?
+      File.exist?(HOOK_PATH)
+    end
+  end
+end

data/lib/ai_git_commit/config.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module AiGitCommit
+  # Configuration class for AiGitCommit
+  class Config
+    attr_accessor :openai_api_key, :model, :program_language,
+                  :max_tokens, :temperature, :system_role_message
+
+    # Initializes configuration with default values
+    def initialize
+      @openai_api_key = ENV["OPENAI_API_KEY"]
+      @model = "gpt-3.5-turbo"
+      @program_language = "Ruby"
+      @max_tokens = 300
+      @temperature = 0.7
+      @system_role_message = <<~MESSAGE
+        You are a senior #{@program_language} developer. Your task is to write a concise, clear commit
+        message and a detailed description based on the provided code changes. The message
+        should be in the imperative mood. The body should be wrapped at 72 characters.
+      MESSAGE
+    end
+  end
+
+  # Module-level accessor for configuration
+  class << self
+    # Returns current configuration or initializes it
+    # @return [Config]
+    def config
+      @config ||= Config.new
+    end
+
+    # Yields the configuration for modification
+    # @yield [Config] config
+    def configure
+      yield(config)
+    end
+  end
+end

data/lib/ai_git_commit/generator.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "openai"
+
+module AiGitCommit
+  # Generator class responsible for creating AI-generated git commit messages
+  class Generator
+    class << self
+      # Generates a commit message using OpenAI based on staged git diff
+      # @return [String] the generated commit message or an error message
+      def commit_message
+        return "# AI skipped: OPENAI_API_KEY is not set." unless openai_api_key
+
+        diff = staged_diff
+        return "# No staged changes found." if diff.strip.empty?
+
+        fetch_message(diff)
+      rescue StandardError => e
+        "# Error: #{e.message}"
+      end
+
+      private
+
+      # Sends the staged diff to OpenAI and returns the generated message
+      # @param diff [String] the staged git diff
+      # @return [String] the commit message from OpenAI
+      def fetch_message(diff)
+        response = openai.chat.completions.create(completion_payload(diff))
+        response.choices.first.message.content
+      end
+
+      # Builds the payload for the OpenAI API request
+      # @param diff [String] the staged git diff
+      # @return [Hash] the payload for OpenAI API
+      def completion_payload(diff)
+        {
+          model: config.model,
+          messages: [
+            { role: "system", content: config.system_role_message },
+            { role: "user", content: user_role_message(diff) }
+          ],
+          max_tokens: config.max_tokens,
+          temperature: config.temperature
+        }
+      end
+
+      # Formatted message instructing the AI to create a Git commit message and description.
+      # @param diff [String] The diff content representing changes in the repository.
+      # @return [String] A formatted message ready to be sent to the AI.
+      def user_role_message(diff)
+        <<~CONTENT
+          Generate a git commit message and description for the following changes.
+          Do not include control chars. Keep description under 200-300 chars.\n
+          Changes:\n(#{diff})
+        CONTENT
+      end
+
+      # Returns an instance of OpenAI::Client
+      # @return [OpenAI::Client]
+      def openai
+        @openai ||= OpenAI::Client.new(api_key: openai_api_key)
+      end
+
+      # Returns the configuration for AiGitCommit
+      # @return [AiGitCommit::Config]
+      def config
+        @config ||= AiGitCommit.config
+      end
+
+      # Returns the OpenAI API key from configuration
+      # @return [String, nil] the API key or nil if not set
+      def openai_api_key
+        AiGitCommit.config.openai_api_key
+      end
+
+      # Gets the staged git diff
+      # @return [String] the output of `git diff --cached`
+      def staged_diff
+        `git diff --cached`
+      end
+    end
+  end
+end

data/lib/ai_git_commit/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AiGitCommit
+  VERSION = "0.1.2"
+end

data/lib/ai_git_commit.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "ai_git_commit/version"
+require_relative "ai_git_commit/config"
+require_relative "ai_git_commit/generator"
+
+module AiGitCommit; end

data/lib/templates/ai_git_commit.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+AiGitCommit.configure do |config|
+  # OpenAI API key
+  config.api_key = ENV["OPENAI_API_KEY"]
+
+  # Specifies the OpenAI model to use for generating commit messages.
+  config.model = "gpt-3.5-turbo"
+
+  # Defines the programming language context for commit message generation.
+  config.program_language = "Ruby"
+
+  # Limits the maximum number of tokens in the generated response.
+  config.max_tokens = 300
+
+  # Controls the randomness of the AI's output (0.0 = deterministic, 1.0 = creative).
+  config.temperature = 0.7
+
+  # Sets the system prompt for the AI
+  config.system_role_message = <<~MESSAGE
+    You are a senior #{config.program_language} developer. Your task is to write a concise, clear commit
+    message and a detailed description based on the provided code changes. The message
+    should be in the imperative mood. The body should be wrapped at 72 characters.
+  MESSAGE
+end

data/sig/ai_git_commit.rbs

@@ -0,0 +1,4 @@
+module AiGitCommit
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ai_git_commit
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mike Belyaev
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |
+  A gem that leverages OpenAI's API to automatically generate
+  Git commit messages based on staged changes.
+email:
+- pair.dro@gmail.com
+executables:
+- ai_git_commit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/ai_git_commit
+- lib/ai_git_commit.rb
+- lib/ai_git_commit/cli.rb
+- lib/ai_git_commit/config.rb
+- lib/ai_git_commit/generator.rb
+- lib/ai_git_commit/version.rb
+- lib/templates/ai_git_commit.rb
+- sig/ai_git_commit.rbs
+homepage: https://github.com/drkmen/ai_git_commit
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/drkmen/ai_git_commit
+  source_code_uri: https://github.com/drkmen/ai_git_commit
+  changelog_uri: https://github.com/drkmen/ai_git_commit/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: AI Git Commit generates Git commit messages using OpenAI.
+test_files: []