committer 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131648bca91f63a2fd32dc1dde7048f70ce3e3d0bc919d6737ff2ec098914fc2
-  data.tar.gz: dd1734f574490501b34589c8494eae3edf8db202c97372b2b961088100280855
+  metadata.gz: 9dce742b36edfa9cef8ad7811bccfef3ca049a91a92cd05264b4004423a1afb9
+  data.tar.gz: 50c8ff360e6905279969af7537e2b6e4cd4f918fec61a65ec1b9333e943906e0
 SHA512:
-  metadata.gz: 03fbecc6488b914a31d8793015a4a0268ffd1c961bde13ff9df8440a2aa950ea904379c46262922439ac61d2976cdb5f2322747133b2bee0ce5371ad50aa45d5
-  data.tar.gz: 3e1dc9c66848b9039b233ed44ed46d16e6ed48c5c8f66129d25a23ee420cb00613d6164b4a4a0ea4ab3b9e18ac7357b8efd5e6e08e8b69bc9c4ab1279c9671e0
+  metadata.gz: a9b64954d73434cb9c095b32426f673fe544d23d1d1b0bf74da1ab29b700f77e1a7b3b2d5cd9d571d4e005b706d0369f08666317b521996d18145c6fd2224f6a
+  data.tar.gz: e453d6be97c3ab39aa2fc19c13236477d3b6aed625841e2e2d6035d435adda196ab83353e4763788858e0e4ee328a6f01fd8423412b86679a373648f1b776f45

data/README.md

@@ -4,35 +4,34 @@ An AI-powered git commit message generator using Claude.
 
 ## Overview
 
-Committer uses Claude AI to analyze your staged git changes and generate conventional commit messages for you. It detects the type of changes (feature, fix, refactor, etc.) and creates a well-formatted commit message that follows best practices.
+The goal of committer is to make it easier to write beautiful commits.
 
-## Installation
+Committer uses Claude AI to analyze your staged git changes and generate [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages for you. It detects the type of changes (feature, fix, refactor, etc.) and creates a well-formatted commit message that follows best practices.
 
-### Install from RubyGems
+## What Makes a Good Commit
 
-```bash
-gem install committer
-```
+A good commit should:
+
+- Have a summary that clearly describes the change
+- Explain WHY the change was made, not just what changed
 
-### Manual Installation
+When a future developer uses git blame to understand a line of code, they should immediately understand why the change was made. This context is invaluable for maintaining and evolving the codebase effectively.
 
-1. Install Bundler if you haven't already:
+## How Committer Helps
 
-   ```sh
-   gem install bundler
-   ```
+Committer analyzes your code changes and generates commit messages that:
 
-2. Install the project dependencies:
+1. Provide a clean, descriptive summary of the change
+2. Include context about why the change was necessary
+3. Follow [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format for consistency
 
-   ```sh
-   bundle install
-   ```
+## Installation
 
-3. Link the executable:
-   ```bash
-   gem build committer.gemspec
-   gem install committer-0.1.0.gem
-   ```
+### Install from RubyGems
+
+```bash
+gem install committer
+```
 
 ## Configuration
 
@@ -44,13 +43,19 @@ committer setup
 
 This will create a template config file at `~/.committer/config.yml`.
 
-Next, edit this file to add your Anthropic API key and optionally change the model:
+Next, edit this file to add your Anthropic API key and optionally change the model or configure commit scopes:
 
 ```yaml
 api_key: your_anthropic_api_key_here
 model: claude-3-7-sonnet-20250219
+scopes:
+  - feature
+  - api
+  - ui
 ```
 
+The `scopes` configuration is optional. When provided, Committer will generate [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) messages with scopes (like `feat(api): add new endpoint`). If left as `null` or omitted, commit messages will be generated without scopes (like `feat: add new endpoint`).
+
 You only need to do this setup once.
 
 ## Usage
@@ -64,21 +69,62 @@ committer
 This will:
 
 1. Get the diff of your staged changes
-2. Send it to Claude for analysis
-3. Generate a commit message in conventional format
-4. Open your default git editor with the suggested message
-5. Allow you to edit the message if needed or simply save to confirm
+2. Ask you for optional context about why you're making the change
+3. Send the diff and context to Claude for analysis
+4. Generate a commit message in [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) format (with scope if configured)
+5. Open your default git editor with the suggested message
+6. Allow you to edit the message if needed or simply save to confirm
 
 ## Commands
 
 - `committer` - Generate commit message for staged changes
 - `committer setup` - Create the config file template
 - `committer help` - Display help information
+- `committer setup-git-hook` - Install the git hook for automatic commit message generation
+- `committer output-message` - Generate a commit message (used by the git hook)
+
+## Git Hook Integration
+
+Committer can be integrated directly with Git using a prepare-commit-msg hook, which automatically generates commit messages whenever you commit.
+
+### Installing the Git Hook
+
+To install the git hook, navigate to the root of your git repository and run:
+
+```bash
+committer setup-git-hook
+```
+
+This command will:
+1. Verify you're in the root of a git repository
+2. Install the prepare-commit-msg hook in your `.git/hooks` directory
+3. Make the hook executable
+
+### How the Git Hook Works
+
+Once installed, the git hook will:
+1. Automatically run whenever you execute `git commit`
+2. Generate an AI-powered commit message based on your staged changes
+3. Pre-fill your commit message editor with the generated message
+4. Allow you to edit the message before finalizing the commit
+
+Since git hooks run in non-interactive mode, you can provide context for your commit by using the REASON environment variable:
+
+```bash
+REASON="Improve performance by optimizing database queries" git commit
+```
+
+If you don't provide a REASON, the commit message will still be generated, but without the additional context that would be used to generate a more detailed body.
+
+## Development
+
+### Running Tests
 
-You can also run it directly through git:
+Committer uses RSpec for testing. To run the tests:
 
 ```bash
-git smart-commit
+bundle install
+bundle exec rake spec
 ```
 
 ## License

data/bin/committer

@@ -2,122 +2,12 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'open3'
-require 'httparty'
-require 'yaml'
 require_relative '../lib/committer/config'
-require_relative '../lib/committer/prompt_templates'
-require_relative '../lib/clients/claude_client'
+require_relative '../lib/committer/commit_generator'
+require_relative '../lib/committer/commands'
 
 # Handle command line arguments
 command = ARGV[0]
+args = ARGV[1..]
 
-case command
-when 'setup'
-  Committer::Config.setup
-  exit 0
-
-when 'help', '--help', '-h'
-  puts 'Committer - AI-powered git commit message generator'
-  puts
-  puts 'Commands:'
-  puts '  committer setup  - Create the config file template at ~/.committer/config.yml'
-  puts '  committer        - Generate commit message for staged changes'
-  puts
-  exit 0
-end
-
-# Default behavior: generate commit message
-def build_commit_prompt(diff, commit_context = nil)
-  scopes = Committer::Config.load
-  scope_section = scopes.empty? ? '' : "\nScopes:\n#{scopes.map { |s| "- #{s}" }.join("\n")}"
-  scope_instruction = if scopes.empty?
-                        '- DO NOT include a scope in your commit message'
-                      else
-                        '- Choose an appropriate scope from the list above if relevant to the change'
-                      end
-  format(template(commit_context),
-         diff: diff,
-         scopes_section: scope_section,
-         scope_instruction: scope_instruction,
-         commit_context: commit_context)
-end
-
-def template(commit_context)
-  if commit_context.nil? || commit_context.empty?
-    Committer::PromptTemplates::SUMMARY_ONLY
-  else
-    Committer::PromptTemplates::SUMMARY_AND_BODY
-  end
-end
-
-def check_git_status
-  stdout, stderr, status = Open3.capture3('git diff --staged')
-
-  unless status.success?
-    puts 'Error executing git diff --staged:'
-    puts stderr
-    exit 1
-  end
-
-  if stdout.empty?
-    puts 'No changes are staged for commit.'
-    exit 0
-  end
-
-  stdout
-end
-
-def parse_response(response, commit_context)
-  text = response.dig('content', 0, 'text')
-
-  # If user didn't provide context, response should only be a summary line
-  if commit_context.nil? || commit_context.empty?
-    { summary: text.strip, body: nil }
-  else
-    # Split the response into summary and body
-    message_parts = text.split("\n\n", 2)
-    summary = message_parts[0].strip
-    body = message_parts[1]&.strip
-
-    # Wrap body text at 80 characters
-    body = body.gsub(/(.{1,80})(\s+|$)/, "\\1\n").strip if body
-
-    { summary: summary, body: body }
-  end
-end
-
-def prepare_commit_message(diff, commit_context = nil)
-  client = Clients::ClaudeClient.new
-  puts 'Sending diff to Claude...'
-
-  prompt = build_commit_prompt(diff, commit_context)
-  response = client.post(prompt)
-  parse_response(response, commit_context)
-end
-
-def execute_git_diff_staged
-  diff = check_git_status
-
-  # Prompt user for commit context
-  puts 'Why are you making this change? (Press Enter to skip)'
-  commit_context = gets.chomp
-
-  commit_message = prepare_commit_message(diff, commit_context)
-
-  summary = commit_message[:summary]
-  body = commit_message[:body]
-
-  # Create git commit with the suggested message and open in editor
-  if body
-    system('git', 'commit', '-m', summary, '-m', body, '-e')
-  else
-    system('git', 'commit', '-m', summary, '-e')
-  end
-rescue Clients::ClaudeClient::ConfigError, StandardError => e
-  puts "Error: #{e.message}"
-  exit 1
-end
-
-# Execute the function if no specific command was given
-execute_git_diff_staged
+Committer::Commands.run(command, args)

data/lib/committer/commands/default.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class Default
+      def self.execute_commit(diff, commit_context)
+        commit_generator = Committer::CommitGenerator.new(diff, commit_context)
+        commit_message = commit_generator.prepare_commit_message
+
+        summary = commit_message[:summary]
+        body = commit_message[:body]
+        # Create git commit with the suggested message and open in editor
+        if body
+          system('git', 'commit', '-m', summary, '-m', body, '-e')
+        else
+          system('git', 'commit', '-m', summary, '-e')
+        end
+      end
+
+      def self.execute(_args)
+        diff = Committer::CommitGenerator.check_git_status
+
+        if diff.empty?
+          puts 'No changes are staged for commit.'
+          exit 0
+        end
+
+        # Prompt user for commit context
+        puts 'Why are you making this change? (Press Enter to skip)'
+        commit_context = gets.chomp
+        execute_commit(diff, commit_context)
+      rescue Clients::ClaudeClient::ConfigError, StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+    end
+  end
+end

data/lib/committer/commands/help.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class Help
+      def self.execute(_args)
+        puts 'Committer - AI-powered git commit message generator'
+        puts
+        puts 'Commands:'
+        puts '  committer setup          - Create the config file template at ~/.committer/config.yml'
+        puts '  committer                - Generate commit message for staged changes'
+        puts '  committer output-message - Generate commit message without creating a commit'
+        puts '  committer setup-git-hook - Install the prepare-commit-msg git hook'
+        puts
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/output_message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class OutputMessage
+      def self.execute(args)
+        commit_context = args[0]
+        diff = Committer::CommitGenerator.check_git_status
+
+        commit_generator = Committer::CommitGenerator.new(diff, commit_context)
+        commit_message = commit_generator.prepare_commit_message
+
+        summary = commit_message[:summary]
+        body = commit_message[:body]
+
+        puts <<~OUTPUT
+          #{summary}
+
+          #{body}
+        OUTPUT
+        exit 0
+      rescue Clients::ClaudeClient::ConfigError => e
+        puts "Error: #{e.message}"
+        exit 1
+      rescue StandardError
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/setup.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class Setup
+      def self.execute(_args)
+        Committer::Config.setup
+        exit 0
+      end
+    end
+  end
+end

data/lib/committer/commands/setup_git_hook.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Committer
+  module Commands
+    class SetupGitHook
+      HOOK_PATH = '.git/hooks/prepare-commit-msg'
+
+      def self.execute(_args)
+        validate_git_repository
+        install_git_hook
+        display_success_message
+        exit 0
+      rescue StandardError => e
+        puts "Error: #{e.message}"
+        exit 1
+      end
+
+      def self.validate_git_repository
+        validate_git_root
+        validate_git_directory_exists
+        validate_hook_doesnt_exist
+      end
+
+      def self.validate_git_directory_exists
+        return if Dir.exist?('.git')
+
+        puts 'Error: Current directory is not a git repository.'
+        exit 1
+      end
+
+      def self.validate_git_root
+        git_toplevel = `git rev-parse --show-toplevel`.strip
+        current_dir = Dir.pwd
+        return if git_toplevel == current_dir
+
+        puts 'Error: Please run this command from the root of your git repository.'
+        exit 1
+      end
+
+      def self.validate_hook_doesnt_exist
+        return unless File.exist?(HOOK_PATH)
+
+        puts 'Error: prepare-commit-msg hook already exists.'
+        puts 'Please remove or rename the existing hook and try again.'
+        exit 1
+      end
+
+      def self.install_git_hook
+        template_path = File.expand_path('../prepare-commit-msg', __dir__)
+        hook_content = File.read(template_path)
+        File.write(HOOK_PATH, hook_content)
+        File.chmod(0o755, HOOK_PATH)
+      end
+
+      def self.display_success_message
+        puts 'Git hook successfully installed!'
+        puts 'Now your commit messages will be automatically generated.'
+      end
+    end
+  end
+end

data/lib/committer/commands.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'commands/setup'
+require_relative 'commands/help'
+require_relative 'commands/output_message'
+require_relative 'commands/setup_git_hook'
+require_relative 'commands/default'
+
+module Committer
+  module Commands
+    def self.run(command, args)
+      case command
+      when 'setup'
+        Setup.execute(args)
+      when 'help', '--help', '-h'
+        Help.execute(args)
+      when 'output-message'
+        OutputMessage.execute(args)
+      when 'setup-git-hook'
+        SetupGitHook.execute(args)
+      else
+        Default.execute(args)
+      end
+    end
+  end
+end

data/lib/committer/commit_generator.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'httparty'
+require 'yaml'
+require_relative 'config'
+require_relative 'prompt_templates'
+require_relative '../clients/claude_client'
+
+module Committer
+  class CommitGenerator
+    attr_reader :diff, :commit_context
+
+    def initialize(diff, commit_context = nil)
+      @diff = diff
+      @commit_context = commit_context
+    end
+
+    def build_commit_prompt
+      scopes = Committer::Config.load
+      scope_section = scopes.empty? ? '' : "\nScopes:\n#{scopes.map { |s| "- #{s}" }.join("\n")}"
+      scope_instruction = if scopes.empty?
+                            '- DO NOT include a scope in your commit message'
+                          else
+                            '- Choose an appropriate scope from the list above if relevant to the change'
+                          end
+      format(template,
+             diff: @diff,
+             scopes_section: scope_section,
+             scope_instruction: scope_instruction,
+             commit_context: @commit_context)
+    end
+
+    def template
+      if @commit_context.nil? || @commit_context.empty?
+        Committer::PromptTemplates::SUMMARY_ONLY
+      else
+        Committer::PromptTemplates::SUMMARY_AND_BODY
+      end
+    end
+
+    def self.check_git_status
+      stdout, stderr, status = Open3.capture3('git diff --staged')
+
+      unless status.success?
+        puts 'Error executing git diff --staged:'
+        puts stderr
+        exit 1
+      end
+
+      stdout
+    end
+
+    def parse_response(response)
+      text = response.dig('content', 0, 'text')
+
+      # If user didn't provide context, response should only be a summary line
+      if @commit_context.nil? || @commit_context.empty?
+        { summary: text.strip, body: nil }
+      else
+        # Split the response into summary and body
+        message_parts = text.split("\n\n", 2)
+        summary = message_parts[0].strip
+        body = message_parts[1]&.strip
+
+        # Wrap body text at 80 characters
+        body = body.gsub(/(.{1,80})(\s+|$)/, "\\1\n").strip if body
+
+        { summary: summary, body: body }
+      end
+    end
+
+    def prepare_commit_message
+      client = Clients::ClaudeClient.new
+
+      prompt = build_commit_prompt
+      response = client.post(prompt)
+      parse_response(response)
+    end
+  end
+end

data/lib/committer/config.rb

@@ -19,7 +19,8 @@ module Committer
       begin
         YAML.load_file(CONFIG_FILE) || DEFAULT_CONFIG
       rescue StandardError => e
-        puts "Error loading config: #{e.message}"
+        # Use $stdout directly for better test capture
+        $stdout.puts "Error loading config: #{e.message}"
         DEFAULT_CONFIG
       end
     end

data/lib/committer/prepare-commit-msg

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Check if parameters 2 and 3 are null
+if [ -z "$2" ] && [ -z "$3" ]; then
+    # Check if parameter 1 is provided and is a valid file
+    if [ -z "$1" ]; then
+        echo "Error: No target file specified in parameter 1"
+        exit 1
+    fi
+    
+    if [ ! -f "$1" ]; then
+        echo "Error: File '$1' does not exist"
+        exit 1
+    fi
+    
+    # Check if committer command exists
+    if command -v committer &> /dev/null; then
+        # Execute committer command and capture its output
+        COMMITTER_OUTPUT=$(committer output-message "$REASON")
+        
+        # Create a temporary file with the committer output at the top
+        # followed by the original content of the file
+        {
+            echo "$COMMITTER_OUTPUT"
+            cat "$1"
+        } > "$1.tmp"
+        
+        # Replace the original file with the temporary file
+        mv "$1.tmp" "$1"
+        
+        echo "Successfully added committer output to the top of $1"
+    else
+        echo "Committer command not found - no action taken"
+    fi
+fi

data/lib/committer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committer
-  VERSION = '0.2.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: committer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Sebastien Stettler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-06 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -29,16 +29,22 @@ description: A tool that uses Claude API to generate conventional commit message
 email:
 - sebastien@managerbot.dev
 executables:
-- git-smart-commit
 - committer
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - bin/committer
-- bin/git-smart-commit
 - lib/clients/claude_client.rb
+- lib/committer/commands.rb
+- lib/committer/commands/default.rb
+- lib/committer/commands/help.rb
+- lib/committer/commands/output_message.rb
+- lib/committer/commands/setup.rb
+- lib/committer/commands/setup_git_hook.rb
+- lib/committer/commit_generator.rb
 - lib/committer/config.rb
+- lib/committer/prepare-commit-msg
 - lib/committer/prompt_templates.rb
 - lib/committer/version.rb
 homepage: https://github.com/Hyper-Unearthing/committer

data/bin/git-smart-commit

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-# This is a git integration script that allows users to run:
-# git smart-commit
-# which will forward to the committer command
-
-require_relative 'committer'