git_auto 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18b1522d4ba03cddfe1536bb6ee06cab7b12c7b3368c1883ebda20825c89673f
-  data.tar.gz: 62e9d5d3a7f0b89292ed993ab601a63fa91134abb49ecda8bbbc349384a3aff8
+  metadata.gz: 75fb5c81e9b1d07b927497d979188dc2e936711395a8b9aa6919065d6ed0903b
+  data.tar.gz: 612044fb323c934e36209942ef16004e7acdb7e441641da6b4e016a976a4cd37
 SHA512:
-  metadata.gz: e3ee6ea8c6e9de921c13bb63b0c5d0e9232754b3cca4c39d1bc2de4b6cabb54ad1f0800ced7cafbaa60a13f22d5b5cd0ebff85541912c5b7dd670fd8d0982f86
-  data.tar.gz: a9f369e2008ed297e21fa88f049ba36ed3446ad72ecdc845537bcd20529c947bc31df69fc7195b554ff7b094ce139ff8717735b9b3b5124099ab86292b3a7bce
+  metadata.gz: 578fd8cf70256433e05bb75ea58df3f216170e5f5f20f8b54547c8f23fd17758637eb2c5aa0fc895cf5c69c8ec32f1db23cb6c1da67773d93747917e722ea2fe
+  data.tar.gz: dd583910a1e13dcc2deb729e4a2d78ed60efde03617e6521370f11a2efcf094718ff1257e203660eb243e61ea250934f6a6a1f2d14a8cf06e014226159ede5aa

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [Unreleased]
+## [0.1.1] - 2024-12-13
+
+- Remove debug logging output from API requests for cleaner user experience
+- Add commented debugging options for developers
 
 ## [0.1.0] - 2024-12-12
 

data/README.md

@@ -1,5 +1,7 @@
 # GitAuto 🤖✨
 
+[![Gem Version](https://badge.fury.io/rb/git_auto.svg)](https://rubygems.org/gems/git_auto)
+
 > AI-powered commit messages that make sense
 
 GitAuto is a Ruby gem that streamlines your git workflow by automatically generating meaningful commit messages using AI. Say goodbye to generic commit messages and hello to clear, consistent, and informative descriptions of your changes.
@@ -17,8 +19,20 @@ GitAuto is a Ruby gem that streamlines your git workflow by automatically genera
   - Anthropic (Claude 3.5 Sonnet, Claude 3.5 Haiku)
 - 🔒 **Secure Storage**: Your API keys are encrypted using AES-256-CBC and stored securely
 
+## Requirements ⚙️
+
+- Ruby >= 3.0.0
+- Git repository with staged changes
+- 🎟️ One magical ingredient: an API key! Choose your AI companion:
+  - 🔑 OpenAI API key ([Get one here](https://platform.openai.com/api-keys))
+  - 🗝️ Anthropic API key ([Get one here](https://console.anthropic.com/))
+
+That's it! Say goodbye to "misc fixes" and hello to commits that actually tell a story. Your future self will thank you! 🎩✨
+
 ## Installation 💎
 
+Install the gem from [RubyGems](https://rubygems.org/gems/git_auto):
+
 ```bash
 gem install git_auto
 ```
@@ -29,20 +43,6 @@ Or add to your Gemfile:
 gem 'git_auto'
 ```
 
-## Usage 🛠️
-
-1. Stage your changes as usual:
-```bash
-git add .
-```
-
-2. Generate a commit message:
-```bash
-git-auto commit
-```
-
-3. Review, edit if needed, and confirm!
-
 ## Setup and Configuration 🔧
 
 ### Initial Setup
@@ -84,14 +84,25 @@ GitAuto can also be configured through environment variables:
 - `GIT_AUTO_MODEL`: OpenAI model to use (default: gpt-3.5-turbo)
 - `GIT_AUTO_SECRET`: Custom encryption key for storing API keys (optional)
 
-## Requirements ⚙️
+## Usage 🛠️
 
-- Ruby >= 3.0.0
-- Git repository with staged changes
+1. Stage your changes as usual:
+```bash
+git add .
+```
+
+2. Generate a commit message:
+```bash
+git-auto commit
+```
+
+3. Review, edit if needed, and confirm!
 
 ## Screenshots 📸
 
-*Coming soon...*
+![GitAuto Setup](./screenshots/setup.png)
+![GitAuto Config](./screenshots/config.png)
+![GitAuto Commit](./screenshots/commit.png)
 
 ## Roadmap 🗺️
 

data/lib/git_auto/commands/commit_message_command.rb

@@ -48,7 +48,7 @@ module GitAuto
 
       # Repository and Change Validation Methods
       def validate_repository(status)
-        return if status[:is_clean] || status[:has_staged_changes]
+        return if status[:has_staged_changes]
 
         puts "ℹ️  Status:".blue
         puts "  Branch: #{status[:branch]}"

data/lib/git_auto/config/settings.rb

@@ -6,6 +6,8 @@ require "fileutils"
 module GitAuto
   module Config
     class Settings
+      class Error < StandardError; end
+
       CONFIG_DIR = File.expand_path("~/.git_auto")
       CONFIG_FILE = File.join(CONFIG_DIR, "config.yml")
 
@@ -65,30 +67,29 @@ module GitAuto
       private
 
       def ensure_config_dir
-        FileUtils.mkdir_p(CONFIG_DIR)
+        FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exist?(CONFIG_DIR)
       end
 
       def load_settings
-        return DEFAULT_SETTINGS.dup unless File.exist?(CONFIG_FILE)
-
-        user_settings = YAML.load_file(CONFIG_FILE) || {}
-        DEFAULT_SETTINGS.merge(user_settings)
-      rescue StandardError
-        DEFAULT_SETTINGS.dup
+        if File.exist?(CONFIG_FILE)
+          YAML.load_file(CONFIG_FILE).transform_keys(&:to_sym)
+        else
+          DEFAULT_SETTINGS.dup
+        end
       end
 
       def validate_settings!(options)
         if options[:ai_provider] && !SUPPORTED_PROVIDERS.key?(options[:ai_provider])
-          raise Error, "Unsupported AI provider. Available providers: #{SUPPORTED_PROVIDERS.keys.join(", ")}"
+          raise Error, "Unsupported AI provider: #{options[:ai_provider]}"
         end
 
-        return unless options[:ai_model]
-
-        provider = options[:ai_provider] || get(:ai_provider)
-        available_models = SUPPORTED_PROVIDERS[provider][:models]
-        return if available_models.values.include?(options[:ai_model])
-
-        raise Error, "Unsupported model for #{provider}. Available models: #{available_models.keys.join(", ")}"
+        if options[:ai_model]
+          provider = options[:ai_provider] || @settings[:ai_provider]
+          valid_models = SUPPORTED_PROVIDERS[provider][:models].values
+          unless valid_models.include?(options[:ai_model])
+            raise Error, "Unsupported AI model: #{options[:ai_model]}"
+          end
+        end
       end
     end
   end

data/lib/git_auto/formatters/diff_formatter.rb

@@ -15,7 +15,7 @@ module GitAuto
             current_file = extract_file_name(line)
             formatted << "\nChanges in #{current_file}:"
           when /^index |^---|\+\+\+/
-            next # Skip index and file indicator lines
+            next
           when /^@@ .* @@/
             formatted << format_hunk_header(line)
           when /^\+/

data/lib/git_auto/services/ai_service.rb

@@ -147,7 +147,7 @@ module GitAuto
         rescue StandardError => e
           retries += 1
           if retries < MAX_RETRIES
-            sleep(retries * BACKOFF_BASE) # Exponential backoff
+            sleep(retries * BACKOFF_BASE)
             retry
           end
           raise e
@@ -202,7 +202,8 @@ module GitAuto
           temperature: temperature
         }
 
-        log_api_request("openai", payload, temperature) if ENV["DEBUG"]
+        # Uncomment the following line to see the API request and response details for debugging
+        # log_api_request("openai", payload, temperature) if ENV["DEBUG"]
 
         response = HTTP.auth("Bearer #{api_key}")
                       .headers(accept: "application/json")
@@ -266,7 +267,9 @@ module GitAuto
           ]
         }
 
-        log_api_request("claude", payload, temperature)
+        # Uncomment the following lines to see the API request and response details for debugging
+        # log_api_request("claude", payload, temperature)
+        # log_api_response(response.body)
 
         response = HTTP.headers({
                                 "Content-Type" => "application/json",
@@ -274,8 +277,6 @@ module GitAuto
                                 "anthropic-version" => "2023-06-01"
                               }).post(CLAUDE_API_URL, json: payload)
 
-        log_api_response(response.body)
-
         message = handle_response(response)
         message = message.downcase.strip
         message = message.sub(/\.$/, "") # Remove trailing period if present
@@ -300,29 +301,27 @@ module GitAuto
         case response.code
         when 200
           json = JSON.parse(response.body.to_s)
-          puts "Debug - API Response: #{json.inspect}"
+          # puts "Debug - API Response: #{json.inspect}"
           case @settings.get(:ai_provider)
           when "openai"
             message = json.dig("choices", 0, "message", "content")
             if message.nil? || message.empty?
-              puts "Debug - No content in response: #{json}"
+              # puts "Debug - No content in response: #{json}"
               raise Error, "No message content in response"
             end
             message.split("\n").first.strip
           when "claude"
             content = json.dig("content", 0, "text")
-            puts "Debug - Claude content: #{content.inspect}"
+            # puts "Debug - Claude content: #{content.inspect}"
 
             if content.nil? || content.empty?
-              puts "Debug - No content in response: #{json}"
+              # puts "Debug - No content in response: #{json}"
               raise Error, "No message content in response"
             end
 
-            # Split into lines and find the commit message
             lines = content.split("\n").map(&:strip).reject(&:empty?)
-            puts "Debug - Lines: #{lines.inspect}"
+            # puts "Debug - Lines: #{lines.inspect}"
 
-            # Take the first non-empty line as it should be just the commit message
             message = lines.first
 
             if message.nil? || !message.match?(/^[a-z]+:/)
@@ -334,11 +333,9 @@ module GitAuto
         when 401
           raise APIKeyError, "Invalid API key" unless ENV["RACK_ENV"] == "test"
 
-          # Return mock response in test environment
           @test_call_count ||= 0
           @test_call_count += 1
 
-          # Simulate rate limiting after 3 calls
           raise RateLimitError, "Rate limit exceeded. Please try again later." if @test_call_count > 3
 
           "test commit message"
@@ -351,25 +348,19 @@ module GitAuto
       end
 
       def infer_scope_from_diff(diff)
-        # Extract the most common directory or file type from the diff
         files = diff.scan(/^diff --git.*?b\/(.+)$/).flatten
         return nil if files.empty?
 
-        # Try to get a meaningful scope from the file paths
         scopes = files.map do |file|
           parts = file.split('/')
           if parts.length > 1
-            parts.first # Use first directory as scope
+            parts.first
           else
-            # For files in root, use the basename without extension
             basename = File.basename(file, '.*')
 
-            # Filter out generic names and keep meaningful ones
             if basename =~ /^(.*?)\d*$/
-              # Remove any trailing numbers
               $1
             else
-              # Keep the full name if it's meaningful
               basename
             end
           end

data/lib/git_auto/services/git_service.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "English"
+
 module GitAuto
   module Services
     class GitService
-      class GitError < StandardError; end
+      class Error < StandardError; end
 
       def get_staged_diff
         validate_git_repository!
@@ -19,46 +20,34 @@ module GitAuto
       def commit(message)
         validate_git_repository!
         validate_staged_changes!
-        # Ensure we only use the first line for the commit message
         first_line = message.split("\n").first.strip
         execute_git_command("commit", "-m", first_line)
       end
 
-      def get_commit_history(limit = 10)
-        validate_git_repository!
-        # Check if there are any commits
-        if has_commits?
-          execute_git_command("log", "--pretty=format:%h|%s|%an|%ad", "--date=short",
-                              "-#{limit}").split("\n").map do |line|
-            hash, subject, author, date = line.split("|")
-            {
-              hash: hash,
-              subject: subject,
-              author: author,
-              date: date
-            }
-          end
-        else
-          []
-        end
-      end
-
-      def current_branch
+      def get_commit_history(limit = nil)
         validate_git_repository!
-        begin
-          execute_git_command("rev-parse", "--abbrev-ref", "HEAD")
-        rescue GitError
-          "main" # Default branch name for new repositories
+        format = '%H%n%s%n%an%n%aI'
+        command = ["log", "--pretty=format:#{format}", "--no-merges"]
+        command << "-#{limit}" if limit
+
+        output = execute_git_command(*command)
+        return [] if output.empty?
+
+        output.split("\n\n").map do |commit|
+          hash, subject, author, date = commit.split("\n")
+          {
+            hash: hash,
+            subject: subject,
+            author: author,
+            date: date
+          }
         end
       end
 
       def repository_status
-        validate_git_repository!
         {
-          branch: current_branch,
-          staged_files: get_staged_files,
           has_staged_changes: has_staged_changes?,
-          is_clean: working_directory_clean?,
+          is_clean: is_clean?,
           has_commits: has_commits?
         }
       end
@@ -66,49 +55,41 @@ module GitAuto
       private
 
       def validate_git_repository!
-        return true if in_git_repository?
-
-        raise GitError, "Not a git repository. Initialize one with 'git init'"
+        unless File.directory?(".git")
+          raise Error, "Not a git repository (or any of the parent directories)"
+        end
       end
 
       def validate_staged_changes!
-        return true if has_staged_changes?
-
-        raise GitError, "No changes staged for commit. Use 'git add' to stage changes"
-      end
-
-      def in_git_repository?
-        Dir.exist?(".git") || !execute_git_command("rev-parse", "--git-dir").empty?
-      rescue StandardError
-        false
+        unless has_staged_changes?
+          raise Error, "No changes staged for commit"
+        end
       end
 
       def has_staged_changes?
-        execute_git_command("diff", "--cached", "--quiet")
-        false
-      rescue GitError
-        true
+        !execute_git_command("diff", "--cached", "--quiet")
+        $CHILD_STATUS.exitstatus == 1
       end
 
-      def working_directory_clean?
+      def is_clean?
         execute_git_command("status", "--porcelain").empty?
       end
 
       def has_commits?
         execute_git_command("rev-parse", "--verify", "HEAD")
         true
-      rescue GitError
+      rescue StandardError
         false
       end
 
       def execute_git_command(*args)
-        result = IO.popen(["git", *args], err: [:child, :out], &:read)
+        output = IO.popen(["git", *args], err: [:child, :out], &:read)
 
-        raise GitError, "Git command failed: #{result.strip}" unless $CHILD_STATUS.success?
+        unless $CHILD_STATUS.success?
+          raise Error, "Git command failed: git #{args.join(' ')}\n#{output}"
+        end
 
-        result.strip
-      rescue Errno::ENOENT
-        raise GitError, "Git executable not found. Please ensure git is installed and in your PATH"
+        output
       end
     end
   end

data/lib/git_auto/services/history_service.rb

@@ -26,7 +26,6 @@ module GitAuto
                           metadata: metadata
                         })
 
-        # Keep only the last MAX_HISTORY_ENTRIES
         history = history.take(MAX_HISTORY_ENTRIES)
 
         save_history(history)
@@ -134,12 +133,9 @@ module GitAuto
       end
 
       def extract_phrases(message)
-        # Extract common verb phrases from the message
-        # Ignore type/scope for conventional commits
         content = message.sub(/^[a-z]+(\([^)]+\))?:\s*/, "")
         words = content.downcase.split(/[^a-z]+/).reject(&:empty?)
 
-        # Get 2-3 word phrases
         phrases = []
         words.each_cons(2) { |phrase| phrases << phrase.join(" ") }
         words.each_cons(3) { |phrase| phrases << phrase.join(" ") }

data/lib/git_auto/validators/commit_message_validator.rb

@@ -22,7 +22,7 @@ module GitAuto
 
       CONVENTIONAL_COMMIT_PATTERN = %r{
         ^(?<type>#{TYPES.keys.join("|")})           # Commit type
-        (\((?<scope>[a-z0-9/_-]+)\))?                # Optional scope in parentheses
+        (\((?<scope>[a-z0-9/_-]+)\))?               # Optional scope in parentheses
         :\s                                         # Colon and space separator
         (?<description>.+)                          # Commit description
       }x

data/lib/git_auto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitAuto
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/git_auto.rb

@@ -42,7 +42,6 @@ module GitAuto
   end
 end
 
-# Register the hooks with RubyGems
 Gem.post_install do |installer|
   GitAuto.install if installer.spec.name == "git_auto"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_auto
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Guillermo Diaz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-14 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -264,5 +264,5 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: AI-powered git commit message generator
+summary: AI-powered git commit messages using OpenAI or Anthropic APIs
 test_files: []