aigcm 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f0e2c18c6c1c820563cc9f640a319709b1cbb752fdee4464617759cd2e6f963
+  data.tar.gz: 3a74e5f33183449a690f5ae8892bd55d438cff57193eb90af1b358458f215c77
+SHA512:
+  metadata.gz: e203e403e07b9865c879d6bee4cedb9545fc460a8cbaa990d9257e00e49a7bf735ac5ee4bd403f2e7dd1ad4ee399734e194d49e55c723d7f184684cee8c5a548
+  data.tar.gz: 22ff6406f1aba1ab8defeac098bc1dab5b0aece00c04801c3aa4b888399a23db974ed89b0387e373a5f05e77a0a99b7834c1da8ffb95c240f926429330d6b1ba

data/.envrc

@@ -0,0 +1,4 @@
+
+export RR=`pwd`
+
+PATH_add $RR/bin

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+## [Unreleased]
+
+## [0.1.0] - 2025-02-08
+
+- changed gem name to aigc
+
+## [0.1.0] - 2025-02-07
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dewayne VanHoozer
+
+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,128 @@
+# aigcm
+
+The **AI git commit message** generator.
+ƒ
+## Overview
+
+**aigcm** is a Ruby gem designed to generate high-quality commit messages for git diffs. It leverages AI to analyze changes in your codebase and create concise, meaningful commit messages following best practices.
+
+## Features
+
+- **Automatic Commit Message Generation**: Automatically generate commit messages based on code diffs.
+- **Security-Aware Provider Selection**: Detects execution in a private repository and ensures non-local providers are not used for security reasons. This means that if you are working within a private repository, the gem will default to local providers unless explicitly forced otherwise.
+- **Configurable Style Guide**: Allows using a specific style guide for commit messages, either from a default location or specified by the user.
+- **AI Model Integration**: Integration with various AI models for enhanced message generation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aigcm'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install aigcm
+```
+
+## Usage
+
+To generate a commit message:
+
+```shell
+aigcm [options] [ref]
+```
+
+### Options
+
+- `-a, --amend`: Amend the last commit.
+- `-c, --context=CONTEXT`: Extra context beyond the diff.
+- `-d, --dry`: Dry run the command without making any changes.
+- `-m, --model=MODEL`: Specify the AI model to use.
+- `--provider=PROVIDER`: Specify the provider (ollama, openai, anthropic, etc). Note: This only needs to be used when the specified model is available from multiple providers; otherwise, the owner of the model is used by default.
+- `--force-external`: Force using external AI provider even for private repos.
+- `-s, --style=STYLE`: Path to the style guide file. If not provided, the system looks for `COMMITS.md` in the repo root or uses the default style guide.
+- `--default`: Print the default style guide and exit the application.
+- `--version`: Show version.
+
+### Examples
+
+If your commit involves refactoring a function to improve its performance, you might provide context like:
+   ```shell
+   aigcm -m MODEL -c "Refactored to improve performance by using algorithm X"
+   ```
+
+   This context helps the AI craft a more informative commit message.
+  
+When your commit is related to a specific JIRA ticket:
+   ```shell
+   aigcm -m MODEL -c "Resolved issues as per JIRA ticket JIRA-1234"
+   ```
+
+   Including the JIRA ticket helps relate the commit to external tracking systems.
+
+Including multiple context strings:
+   ```shell
+   aigcm -m MODEL -c "Refactored for performance" -c "JIRA-1234"
+   ```
+
+   Multiple context strings can be added by repeating the `-c` option.
+
+Using environment variables in context:
+   ```shell
+   aigcm -c "Put the work ticket as the first entry on the subject line" -c "Ticket: $TICKET"
+   ```
+
+   This allows you to dynamically include environment variables in your commit message.
+
+### Style Guide Example
+
+The style guide is used as part of the generative AI prompt that instructs the large language model (LLM) how to craft its summary of the `git diff` results.  The see the default style guide use the `--default` option.
+
+You can create your own style guide named `COMMITS.md` in the root directory of your repository.  You can also use the `--style` option to point `aigcm` to your style guide if you choose to keep it in a different place.  This is handy when you want to have consistent commit messages across several different projects.
+
+This would be a simple style guide:
+
+```
+- Use conventional commits format (type: description)
+- Keep first line under 72 characters
+- Use present tense ("add" not "added")
+- Be descriptive but concise
+- Have fun. Be creative. Add ASCII art if you feel like it.
+```
+
+## Last Thoughts
+
+This gem saves its commit message in the file `.aigcm_msg` at the root directory of the repository.  Its there even if you do a `--dry` run.  This could be handy if you want to incorporate `aigcm` into some larger workflow.
+
+Remember that the style guide can be extended using one or more `--context` strings.  For example you could create a shell alias like this:
+
+```
+alias gc='aigcm -c "JIRA $JIRA_TICKET"'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+1. Fork it (<https://github.com/your_username/aigcm/fork>)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/bin/aigcm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/aigcm'
+
+Aigcm.run

data/lib/aigcm/commit_message_generator.rb

@@ -0,0 +1,113 @@
+
+require "net/http"
+require "json"
+require "open3"
+require "ai_client"
+
+module Aigcm
+  class CommitMessageGenerator
+    class Error < StandardError; end
+
+    MAX_DIFF_SIZE = 4000 # Characters
+
+    def initialize(model:, provider:, max_tokens:, force_external:)
+      @force_external = force_external
+      validate_model_provider_combination(model)
+      check_provider_availability
+
+      @client = AiClient.new(model, provider: provider)
+    rescue StandardError => e
+      raise Error, "Failed to initialize AI client: #{e.message}"
+    end
+
+    def generate(diff, style_guide, context = [])
+      return "No changes to commit" if diff.strip.empty?
+
+      check_repository_privacy unless @force_external
+
+      # Truncate diff if too large
+      if diff.length > MAX_DIFF_SIZE
+        diff = diff[0...MAX_DIFF_SIZE] + "\n...[diff truncated]"
+      end
+
+      processed_context = process_context(context)
+      prompt = build_prompt(diff, style_guide, processed_context)
+
+      begin
+        response = @client.chat(prompt)
+        response.to_s.strip
+      rescue StandardError => e
+        "Error generating commit message: #{e.message}"
+      end
+    end
+
+    private
+
+    def validate_model_provider_combination(model)
+      client = AiClient.new(model)
+      @provider = client.provider
+    rescue ArgumentError => e
+      raise Error, "Invalid model/provider combination: #{e.message}"
+    end
+
+    def check_provider_availability
+      case @provider
+      when :ollama
+        check_ollama_running
+      when :localai
+        check_localai_running
+      end
+    rescue StandardError => e
+      raise Error, "Provider not available: #{e.message}"
+    end
+
+    def check_ollama_running
+      Net::HTTP.get(URI("http://localhost:11434/api/version"))
+    rescue StandardError
+      raise Error, "Ollama is not running. Please start ollama first."
+    end
+
+    def check_localai_running
+      Net::HTTP.get(URI("http://localhost:8080/v1/models"))
+    rescue StandardError
+      raise Error, "LocalAI is not running. Please start localai first."
+    end
+
+    def process_context(context_array)
+      context_array.map do |ctx|
+        if ctx.start_with?("@")
+          filename = ctx[1..]
+          File.read(filename) rescue "Could not read #{filename}"
+        else
+          ctx
+        end
+      end
+    end
+
+    def check_repository_privacy
+      return if @provider == :ollama # Local provider is always safe
+
+      stdout, _, status = Open3.capture3("gh repo view --json isPrivate -q '.isPrivate'")
+
+      if status.success? && stdout.strip == "true"
+        raise Error, "This is a private repository. Use a local model (ollama) or run with --force-external flag"
+      end
+    rescue Errno::ENOENT
+      puts "Warning: Unable to check repository privacy status (gh command not found)"
+    end
+
+    def build_prompt(diff, style_guide, context)
+      <<~PROMPT
+        Generate a commit message for the git diff that follows these instructions.
+        Do not wrap your response in a code block.
+        Follow these style guidelines when constructing your response:
+        #{style_guide}
+
+        #{context.join("\n") unless context.empty?}
+
+        Git diff:
+        #{diff}
+      PROMPT
+    end
+  end
+end

data/lib/aigcm/git_diff.rb

@@ -0,0 +1,44 @@
+require "open3"
+
+module Aigcm
+  class GitDiff
+    class Error < StandardError; end
+
+    def initialize(dir:, commit_hash: nil, amend: false)
+      @dir = dir
+      @commit_hash = commit_hash
+      @amend = amend
+      validate_git_repo
+    end
+
+    def generate_diff
+      Dir.chdir(@dir) do
+        cmd = if @amend
+            "git diff --cached HEAD^ 2>/dev/null || git diff --cached"
+          elsif @commit_hash
+            "git diff #{@commit_hash}^..#{@commit_hash}"
+          else
+            "git diff --cached"
+          end
+
+        stdout, _, status = Open3.capture3(cmd)
+
+        raise Error, "Git command failed" unless status.success?
+        raise Error, "No changes detected" if stdout.strip.empty?
+
+        stdout
+      end
+    end
+
+    private
+
+    def validate_git_repo
+      Dir.chdir(@dir) do
+        _, _, status = Open3.capture3("git rev-parse --git-dir")
+        raise Error, "Not a git repository" unless status.success?
+      end
+    rescue Errno::ENOENT
+      raise Error, "Directory not found: #{@dir}"
+    end
+  end
+end

data/lib/aigcm/style_guide.rb

@@ -0,0 +1,50 @@
+require 'erb'
+
+module Aigcm
+  class StyleGuide
+    LINE_MAX      = 72
+    DEFAULT_GUIDE = ERB.new(
+                      File.read(__FILE__)
+                      .split("__END__")
+                      .last
+                      .strip
+                    ).result
+
+    def self.load(dir, custom_path = nil)
+      # If a custom path is provided, use it
+      if custom_path
+        return load_from_file(custom_path)
+      end
+
+      # Check for COMMITS.md in the repository root
+      config_file = File.join(dir, "COMMITS.md")
+      return load_from_file(config_file) if File.exist?(config_file)
+
+      # Fallback to the default style guide
+      DEFAULT_GUIDE
+    rescue StandardError => e
+      puts "Warning: Error reading style guide: #{e.message}"
+      DEFAULT_GUIDE
+    end
+
+    private_class_method def self.load_from_file(path)
+                           File.read(path)
+                         end
+  end
+end
+
+__END__
+
+1. Craft a Clear Subject Line:
+• Summarize Concisely: Begin with a brief summary (<%= Aigcm::StyleGuide::LINE_MAX %> characters max).
+• Capitalize the Subject: Start the subject line with a capital letter.
+• Omit Periods in Subject Line: Avoid ending with a period to save space.
+• Use Imperative Mood: Phrase commands as direct actions (e.g., "Add feature" instead of "Added feature").
+
+2. Provide a Detailed Body:
+• Seperate the body from the subject line with a blank line.
+• Explain the Reason: Clearly articulate the rationale for the change rather than just summarizing the modification.
+• Wrap Body Text at <%= Aigcm::StyleGuide::LINE_MAX %> Characters: Ensure that the body text wraps at <%= Aigcm::StyleGuide::LINE_MAX %> characters per line.
+
+3. Reference Issues/Tickets:
+• Include relevant issue numbers, ticket IDs and/or references when they are provided.  Dp not invent your own reference.  Use what has been provided.

data/lib/aigcm/version.rb

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

data/lib/aigcm.rb

@@ -0,0 +1,146 @@
+# lib/aigcm.rb
+
+require 'debug_me'
+include DebugMe
+
+require 'optparse'
+require 'ai_client'
+require 'time'
+
+require_relative 'aigcm/version'
+require_relative 'aigcm/git_diff'
+require_relative 'aigcm/commit_message_generator'
+require_relative 'aigcm/style_guide'
+
+module Aigcm
+  COMMIT_MESSAGE_FILE = '.aigcm_msg'
+  RECENT_THRESHOLD = 60 # seconds (1 minute)
+
+  class Error < StandardError; end
+
+  def self.run(test_mode: false)
+    dir = Dir.pwd
+    options = parse_options
+
+    if options[:amend]
+      system('git commit --amend')
+      return
+    end
+
+    commit_message = check_recent_commit(dir)
+
+    # Generate a new commit message if not reusing an existing one
+    commit_message ||= generate_commit_message(dir, options)
+
+    perform_commit(dir, commit_message, options)
+
+  rescue OptionParser::InvalidOption => e
+    STDERR.puts "Error: '#{e.message}'"
+    exit 1
+  rescue GitDiff::Error => e
+    puts "Git error: #{e.message}"
+    exit 1
+  rescue StandardError => e
+    puts "Error: #{e.message}"
+    exit 1
+  end
+
+  private_class_method def self.parse_options
+    options = {
+      amend: false,
+      context: [],
+      dry: false,
+      model: 'gpt-4o-mini',
+      provider: nil,
+      force_external: false,
+      style: nil
+    }
+
+    OptionParser.new do |opts|
+      opts.banner = "Usage: aigcm [options] [ref]"
+
+      opts.on("-a", "--amend", "Amend the last commit") { options[:amend] = true }
+
+      opts.on("-cCONTEXT", "--context=CONTEXT", "Extra context beyond the diff") do |context|
+        options[:context] << context
+      end
+
+      opts.on("-d", "--dry", "Dry run the command") { options[:dry] = true }
+
+      opts.on("-mMODEL", "--model=MODEL", "The model to use") { |model| options[:model] = model }
+
+      opts.on("--provider=PROVIDER", "Specify the provider (ollama, openai, anthropic, etc)") do |provider|
+        provider = provider.to_sym
+        unless [:ollama, :openai, :anthropic, :google, :mistral].include?(provider)
+          puts "Invalid provider specified. Valid providers are: ollama, openai, anthropic, google, mistral"
+          exit 1
+        end
+        options[:provider] = provider
+      end
+
+      opts.on("--force-external", "Force using external AI provider even for private repos") {
+        options[:force_external] = true
+      }
+
+      opts.on("-sSTYLE", "--style=STYLE", "Path to the style guide file") { |style| options[:style] = style }
+
+      opts.on("--default", "Print the default style guide and exit") do
+        puts "\nDefault Style Guide:"
+        puts "-------------------"
+        puts StyleGuide::DEFAULT_GUIDE
+        exit
+      end
+
+      opts.on("--version", "Show version") { puts Aigcm::VERSION; exit }
+
+    end.parse!
+
+    options
+  end
+
+  private_class_method def self.check_recent_commit(dir)
+    commit_file_path = File.join(dir, COMMIT_MESSAGE_FILE)
+
+    if File.exist?(commit_file_path)
+      file_mod_time = File.mtime(commit_file_path)
+      current_time = Time.now
+      if (current_time - file_mod_time).to_i < RECENT_THRESHOLD
+        return File.read(commit_file_path)
+      end
+    end
+
+    nil
+  end
+
+  private_class_method def self.generate_commit_message(dir, options)
+    diff_generator = GitDiff.new(dir: dir, commit_hash: ARGV.shift, amend: options[:amend])
+    diff = diff_generator.generate_diff
+
+    style_guide = StyleGuide.load(dir, options[:style])
+    generator = CommitMessageGenerator.new(
+      model: options[:model],
+      provider: options[:provider],
+      max_tokens: 1000,
+      force_external: options[:force_external]
+    )
+
+    commit_message = generator.generate(diff, style_guide, options[:context])
+    File.write(File.join(dir, COMMIT_MESSAGE_FILE), commit_message)
+    commit_message
+  end
+
+  private_class_method def self.perform_commit(dir, commit_message, options)
+    commit_file_path = File.join(dir, COMMIT_MESSAGE_FILE)
+
+    if options[:dry]
+      puts "\nDry run - would generate commit message:"
+      puts "-"*StyleGuide::LINE_MAX
+      puts commit_message
+      puts "-"*StyleGuide::LINE_MAX
+      puts
+    else
+      File.write(commit_file_path, commit_message)
+      system("git commit --edit -F #{commit_file_path}")
+    end
+  end
+end

data/sig/aicommit.rbs

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

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: aigcm
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Dewayne VanHoozer
+bindir: bin
+cert_chain: []
+date: 2025-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ai_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: |
+  `aigcm` generates meaningful git commit messages using artificial
+  intelligence. It supports multiple AI providers including OpenAI,
+  Anthropic, Google, and local models via Ollama. The gem
+  automatically detects private repositories and defaults to using
+  local models for security. It integrates seamlessly with git
+  workflows and supports various commit scenarios including amending
+  commits and handling staged changes. The gem follows conventional
+  commit message formats and allows customization of commit message
+  styles through configuration.
+email:
+- dvanhoozer@gmail.com
+executables:
+- aigcm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/aigcm
+- lib/aigcm.rb
+- lib/aigcm/commit_message_generator.rb
+- lib/aigcm/git_diff.rb
+- lib/aigcm/style_guide.rb
+- lib/aigcm/version.rb
+- sig/aicommit.rbs
+homepage: https://github.com/MadBomber/aigcm
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/MadBomber/aigcm
+  source_code_uri: https://github.com/MadBomber/aigcm
+  changelog_uri: https://github.com/MadBomber/aigcm/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.3
+specification_version: 4
+summary: AI-powered git commit message generator
+test_files: []