ai-commit-message 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef95bc52d9e0600b53c10e093a2d3c057e61f8746d59495f16e0f29c68699995
-  data.tar.gz: 531a062526261dd27b1927660b817509aaa0fd79490f82ca3d16883aeab4c736
+  metadata.gz: 829bf4eb533e768334fd7f8ff083f2ec00d1c113a4b394b55e2802f4a30eb9db
+  data.tar.gz: 962c1f333ecde972d3710884f5c9cbfcd9afb72755af66bdf6de0d6e44eb8a88
 SHA512:
-  metadata.gz: e8306cabe049db41c31b8cf9568c8cb52771041e5d9c26671984de3bd9c3b16957a6de1178a5aebd6af35990faa0b634e7f888c61cbcc95aa3a4d49d6342c332
-  data.tar.gz: 6348572010d2362c88ec3e7a5bd53fa94233663b0887ab3f9201dc20803aabe11e434c9fb7ebbfa1c59ecc3afb195e18f6f8e6fbb9c035795b2675edd82c357e
+  metadata.gz: 65391923463e9a944a0974962acec6510a2615437b83394f19c7418565a25ab0ceb3f2e5058928df14352f7dd92950367b5529f05bb74fc756364f220cace722
+  data.tar.gz: c6e7f071038a300f68316dc8e9c31a66c8dba1a4e4060f9c06950e0094f42b90d5db23a1fdfdbc0d72718da8a791a57fac18a9746cccb113abc627089b95cb2f

data/README.md

@@ -1,2 +1,107 @@
-# ai-commit-message
-Git commit message suggested by AI
+# AI git commit message
+
+A Ruby gem that automatically generates concise and meaningful git commit messages using AI models via [Ollama](https://github.com/ollama/ollama) or any OpenAI-compatible API.
+
+## Installation
+
+Install the gem using:
+
+```bash
+gem install ai-commit-message
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'ai-commit-message'
+```
+
+And then run:
+
+```bash
+bundle install
+```
+
+## Requirements
+
+- Ruby 3.0 or newer
+- Git repository
+- [Ollama](https://github.com/ollama/ollama) model running locally or other OpenAI-compatible API endpoint
+
+## Usage
+
+### Basic Usage
+
+Generate a commit message for your staged changes:
+
+```bash
+ai-commit-message commit
+```
+
+This will:
+1. Analyze your staged changes (`git diff --cached`)
+2. Review your recent commit history for style consistency
+3. Consider your current branch name
+4. Generate an appropriate commit message
+
+### Configuration
+
+You can configure the gem using the built-in configuration command:
+
+```bash
+ai-commit-message config
+```
+
+This interactive prompt allows you to set:
+- **API URL**: The endpoint for your AI model (defaults to `http://localhost:11434/api/generate`)
+- **Model name**: The AI model to use (defaults to `qwen2.5-coder:7b`, which I personally recommend)
+
+### Command Line Options
+
+Override configuration settings directly:
+
+```bash
+ai-commit-message commit --url=http://your-api-endpoint --model=your-model-name
+```
+
+## How It Works
+
+The gem:
+1. Collects your staged changes using `git diff --cached`
+2. Retrieves your recent commit history for context
+3. Identifies your current branch name
+4. Sends this information to the specified AI model
+5. Returns a concise, contextual commit message (limited to 250 characters)
+
+## Configuration File
+
+The gem stores your configuration in `~/.ai-commit-message.conf`. You can manually edit this file if needed. Example:
+
+```bash
+url=http://localhost:11434/api/generate
+model=qwen2.5-coder:7b
+```
+
+## Models
+
+The default configuration uses Ollama with the `qwen2.5-coder:7b` model, but you can use any model available through your API endpoint.
+
+### Recommended Models
+
+- **qwen2.5-coder:7b**: Good balance of quality and speed (default)
+- **llama3:8b**: Excellent for general commit messages
+- **codellama:7b**: Specialized for code-related commits
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Install dependencies: `bundle install`
+4. Make your changes and add tests if applicable
+5. Commit your changes: `git commit -m 'Add some feature'`
+6. Push to the branch: `git push origin my-new-feature`
+7. Submit a pull request
+
+## License
+
+This gem is available as open source free to use/alter without restrictions.

data/lib/ai-commit-message/cli.rb

@@ -5,17 +5,20 @@ require_relative 'config_manager'
 
 module AiCommitMessage
   class CLI < Thor
+    DEFAULT_URL = 'http://localhost:11434'
+    DEFAULT_MODEL_NAME = 'qwen2.5-coder:7b'
+
     desc "commit", "Generate git commit message"
-    method_option :url, type: :string, default: 'http://localhost:11434/api/generate'
-    method_option :model, type: :string, default: 'qwen2.5-coder:7b'
+    method_option :url, type: :string, default: DEFAULT_URL
+    method_option :model, type: :string, default: DEFAULT_MODEL_NAME
 
-    def commit(options = {})
+    def commit
       git_diff_output = `git diff --cached --no-color`
       git_log_output = `git log --format=%s -n 30`
       git_current_branch = `git branch --show-current`
 
-      url = options[:url] || ConfigManager.get_url || 'http://localhost:11434/api/generate'
-      model = options[:model] || ConfigManager.get_model || 'qwen2.5-coder:7b'
+      url = url_to_be_used(options.url)
+      model = model_to_be_used(options.model)
 
       suggester = AiCommitMessage::Suggester.new(git_diff_output, git_log_output, git_current_branch)
       commit_message = suggester.generate_commit_message(url:, model:)
@@ -27,14 +30,28 @@ module AiCommitMessage
     def config
       prompt = TTY::Prompt.new
 
-      url = prompt.ask("API URL:", default: ConfigManager.get_url || 'http://localhost:11434/api/generate')
-      model = prompt.ask("Model name:", default: ConfigManager.get_model || 'qwen2.5-coder:7b')
+      url = prompt.ask("API URL:", default: ConfigManager.get_url || DEFAULT_URL)
+      model = prompt.ask("Model name:", default: ConfigManager.get_model || DEFAULT_MODEL_NAME)
 
       ConfigManager.set_url(url)
       ConfigManager.set_model(model)
 
       puts "Configuration updated successfully!"
     end
+
+    private
+
+    def url_to_be_used(options_url)
+      return options_url if !options_url.empty? && (options_url != DEFAULT_URL)
+
+      ConfigManager.get_url || DEFAULT_URL
+    end
+
+    def model_to_be_used(options_model)
+      return options_model if !options_model.empty? && (options_model != DEFAULT_MODEL_NAME)
+
+      ConfigManager.get_model || DEFAULT_MODEL_NAME
+    end
   end
 end
 

data/lib/ai-commit-message/config_manager.rb

@@ -3,17 +3,17 @@ require 'fileutils'
 class ConfigManager
   CONFIG_FILE = File.expand_path('~/.ai-commit-message.conf')
 
-  def self.get_url = config['url']
+  def self.get_url = config[:url]
 
   def self.set_url(url)
-    config['url'] = url
+    config[:url] = url
     save_config
   end
 
-  def self.get_model = config['model']
+  def self.get_model = config[:model]
 
   def self.set_model(model)
-    config['model'] = model
+    config[:model] = model
     save_config
   end
 

data/lib/ai-commit-message/suggester.rb

@@ -11,7 +11,7 @@ module AiCommitMessage
     end
 
     def generate_commit_message(url:, model:)
-      url = URI(url)
+      url = URI(url + '/api/generate')
       body = {
         model: model,
         prompt: "Create a concise git commit message with no more than 250 characters. Exclude anything unnecessary such as translation, backticks characters or multiple suggestions, since your entire response will be passed directly into git commit. Consider the following messages as example to follow: #{@git_log_output}.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai-commit-message
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Afonso Neto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-16 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor