git_auto 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75fb5c81e9b1d07b927497d979188dc2e936711395a8b9aa6919065d6ed0903b
-  data.tar.gz: 612044fb323c934e36209942ef16004e7acdb7e441641da6b4e016a976a4cd37
+  metadata.gz: 8ab4962fee719c30fca3c7b4577154fed588495e61b6d95e91bb66ae15f5504e
+  data.tar.gz: 837bac312ba13254250e8b149c97e823557e4099cf7459e40dc993db86468caf
 SHA512:
-  metadata.gz: 578fd8cf70256433e05bb75ea58df3f216170e5f5f20f8b54547c8f23fd17758637eb2c5aa0fc895cf5c69c8ec32f1db23cb6c1da67773d93747917e722ea2fe
-  data.tar.gz: dd583910a1e13dcc2deb729e4a2d78ed60efde03617e6521370f11a2efcf094718ff1257e203660eb243e61ea250934f6a6a1f2d14a8cf06e014226159ede5aa
+  metadata.gz: 2f1aacf6b7c6635baf6f6bbeafabc980f39b6797201bb9eab4602d1845e52b14d7e0afd957047f305260c695830cffb51b92011d445705daea1712d6b62cc732
+  data.tar.gz: 85948f7190233c795197c49f833c249c55fe6e7f381c601deecc494a9aa1b16c56dfd02cbc268830749196a9a58ba24f69b1eff7adfa692b9d83df76270aecfc

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.2.0] - 2024-12-15
+
+### Added
+- New "Minimal" commit message style option for more concise commits
+- Display of AI model used in commit message generation for better transparency
+
+### Fixed
+- Improved Git staged changes detection for more reliable operation
+- Improved commit message validation for both minimal and conventional formats
+
+### Changed
+- Updated AI service integration to support minimal commit style across OpenAI and Claude
+- Improved error handling and user feedback during Git operations
+
 ## [0.1.1] - 2024-12-13
 
 - Remove debug logging output from API requests for cleaner user experience

data/lib/git_auto/commands/commit_message_command.rb

@@ -131,7 +131,11 @@ module GitAuto
       end
 
       def display_message_and_validation(formatted_message, validation)
-        puts "\n📝 Generated commit message:".blue
+        provider = @settings.get(:ai_provider)
+        model = @settings.get(:ai_model)
+        model_info = "(#{provider}/#{model})".light_black
+
+        puts "\n📝 Generated commit message #{model_info}:".blue
         puts formatted_message
 
         display_validation_errors(validation[:errors]) if validation[:errors].any?

data/lib/git_auto/commands/config_command.rb

@@ -151,6 +151,7 @@ module GitAuto
 
       def configure_commit_style
         style = @prompt.select("Choose commit message style:", {
+                                 "Minimal (type: description)" => "minimal",
                                  "Conventional (type(scope): description)" => "conventional",
                                  "Simple (description only)" => "simple"
                                })

data/lib/git_auto/commands/setup_command.rb

@@ -87,6 +87,7 @@ module GitAuto
         @prompt.select(
           "Select default commit message style:",
           [
+            { name: "Minimal (type: subject)", value: "minimal" },
             { name: "Conventional (type(scope): description)", value: "conventional" },
             { name: "Simple (verb + description)", value: "simple" },
             { name: "Detailed (summary + bullet points)", value: "detailed" }

data/lib/git_auto/config/settings.rb

@@ -67,7 +67,7 @@ module GitAuto
       private
 
       def ensure_config_dir
-        FileUtils.mkdir_p(CONFIG_DIR) unless Dir.exist?(CONFIG_DIR)
+        FileUtils.mkdir_p(CONFIG_DIR)
       end
 
       def load_settings
@@ -83,13 +83,13 @@ module GitAuto
           raise Error, "Unsupported AI provider: #{options[:ai_provider]}"
         end
 
-        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
+        return unless options[:ai_model]
+
+        provider = options[:ai_provider] || @settings[:ai_provider]
+        valid_models = SUPPORTED_PROVIDERS[provider][:models].values
+        return if valid_models.include?(options[:ai_model])
+
+        raise Error, "Unsupported AI model: #{options[:ai_model]}"
       end
     end
   end

data/lib/git_auto/services/ai_service.rb

@@ -66,17 +66,27 @@ module GitAuto
       end
 
       def get_system_prompt(style, retry_attempt = 0)
-        base_prompt = case style
-          when "conventional"
-            "You are an expert in writing conventional commit messages..."
-          else
-            "You are an expert in writing clear and concise git commit messages..."
-          end
+        base_prompt = case style.to_s
+                      when "minimal"
+                        "You are an expert in writing minimal commit messages that follow the format: <type>: <description>\n" \
+                        "Rules:\n" \
+                        "1. ALWAYS start with a type from the list above\n" \
+                        "2. NEVER include a scope\n" \
+                        "3. Keep the message under 72 characters\n" \
+                        "4. Use lowercase\n" \
+                        "5. Use present tense\n" \
+                        "6. Be descriptive but concise\n" \
+                        "7. Do not include a period at the end"
+                      when "conventional"
+                        "You are an expert in writing conventional commit messages..."
+                      else
+                        "You are an expert in writing clear and concise git commit messages..."
+                      end
 
         # Add variation for retries
-        if retry_attempt > 0
+        if retry_attempt.positive?
           base_prompt += "\nPlease provide a different perspective or approach than previous attempts."
-          base_prompt += "\nBe more #{%w[specific detailed creative concise].sample} in this attempt."
+          base_prompt += "\nBe more #{["specific", "detailed", "creative", "concise"].sample} in this attempt."
         end
 
         base_prompt
@@ -110,14 +120,30 @@ module GitAuto
         # If diff is too large, use the summarized version
         diff = @diff_summarizer.summarize(diff) if diff.length > MAX_DIFF_SIZE
 
-        if style == "conventional" && scope.nil?
+        if style.to_s == "minimal"
+          message = case @settings.get(:ai_provider)
+                    when "openai"
+                      generate_openai_commit_message(diff, style)
+                    when "claude"
+                      generate_claude_commit_message(diff, style)
+                    end
+
+          # Extract type and description from the message
+          if message =~ /^(\w+):\s*(.+)$/
+            type = ::Regexp.last_match(1)
+            description = ::Regexp.last_match(2)
+            return "#{type}: #{description}"
+          end
+
+          return message
+        elsif style.to_s == "conventional" && scope.nil?
           # Generate both scope and message in one call
           message = case @settings.get(:ai_provider)
-                   when "openai"
-                     generate_openai_commit_message(diff, style)
-                   when "claude"
-                     generate_claude_commit_message(diff, style)
-                   end
+                    when "openai"
+                      generate_openai_commit_message(diff, style)
+                    when "claude"
+                      generate_claude_commit_message(diff, style)
+                    end
 
           # Extract type and scope from the message
           if message =~ /^(\w+)(?:\(([\w-]+)\))?:\s*(.+)$/
@@ -174,24 +200,41 @@ module GitAuto
 
         # Only use temperature variations for retries
         temperature = retry_attempt ? get_temperature(retry_attempt) : TEMPERATURE_VARIATIONS[0][:openai]
-        commit_types = %w[feat fix docs style refactor test chore perf ci build revert].join('|')
-
-        system_message = "You are a commit message generator that MUST follow the conventional commit format: <type>(<scope>): <description>\n" \
-                        "Valid types are: #{commit_types}\n" \
-                        "Rules:\n" \
-                        "1. ALWAYS start with a type from the list above\n" \
-                        "2. ALWAYS use the exact format <type>(<scope>): <description>\n" \
-                        "3. Keep the message under 72 characters\n" \
-                        "4. Use lowercase\n" \
-                        "5. Use present tense\n" \
-                        "6. Be descriptive but concise\n" \
-                        "7. Do not include a period at the end"
+        commit_types = ["feat", "fix", "docs", "style", "refactor", "test", "chore", "perf", "ci", "build",
+                        "revert"].join("|")
+
+        system_message = case style.to_s
+                         when "minimal"
+                           "You are a commit message generator that MUST follow the minimal commit format: <type>: <description>\n" \
+                           "Valid types are: #{commit_types}\n" \
+                           "Rules:\n" \
+                           "1. ALWAYS start with a type from the list above\n" \
+                           "2. NEVER include a scope\n" \
+                           "3. Keep the message under 72 characters\n" \
+                           "4. Use lowercase\n" \
+                           "5. Use present tense\n" \
+                           "6. Be descriptive but concise\n" \
+                           "7. Do not include a period at the end"
+                         when "conventional"
+                           "You are a commit message generator that MUST follow the conventional commit format: <type>(<scope>): <description>\n" \
+                           "Valid types are: #{commit_types}\n" \
+                           "Rules:\n" \
+                           "1. ALWAYS start with a type from the list above\n" \
+                           "2. ALWAYS use the exact format <type>(<scope>): <description>\n" \
+                           "3. Keep the message under 72 characters\n" \
+                           "4. Use lowercase\n" \
+                           "5. Use present tense\n" \
+                           "6. Be descriptive but concise\n" \
+                           "7. Do not include a period at the end"
+                         else
+                           "You are an expert in writing clear and concise git commit messages..."
+                         end
 
         user_message = if scope
-                        "Generate a conventional commit message with scope '#{scope}' for this diff:\n\n#{diff}"
-                      else
-                        "Generate a conventional commit message for this diff:\n\n#{diff}"
-                      end
+                         "Generate a conventional commit message with scope '#{scope}' for this diff:\n\n#{diff}"
+                       else
+                         "Generate a #{style} commit message for this diff:\n\n#{diff}"
+                       end
 
         payload = {
           model: @settings.get(:ai_model),
@@ -206,8 +249,8 @@ module GitAuto
         # log_api_request("openai", payload, temperature) if ENV["DEBUG"]
 
         response = HTTP.auth("Bearer #{api_key}")
-                      .headers(accept: "application/json")
-                      .post(OPENAI_API_URL, json: payload)
+          .headers(accept: "application/json")
+          .post(OPENAI_API_URL, json: payload)
 
         handle_response(response)
       end
@@ -218,33 +261,40 @@ module GitAuto
 
         # Only use temperature variations for retries
         temperature = retry_attempt ? get_temperature(retry_attempt) : TEMPERATURE_VARIATIONS[0][:claude]
-        prompt = retry_attempt ? get_system_prompt(style, retry_attempt) : get_system_prompt(style)
+        commit_types = ["feat", "fix", "docs", "style", "refactor", "test", "chore", "perf", "ci", "build",
+                        "revert"].join("|")
+
+        system_message = case style.to_s
+                         when "minimal"
+                           "You are a commit message generator that MUST follow the minimal commit format: <type>: <description>\n" \
+                           "Valid types are: #{commit_types}\n" \
+                           "Rules:\n" \
+                           "1. ALWAYS start with a type from the list above\n" \
+                           "2. NEVER include a scope\n" \
+                           "3. Keep the message under 72 characters\n" \
+                           "4. Use lowercase\n" \
+                           "5. Use present tense\n" \
+                           "6. Be descriptive but concise\n" \
+                           "7. Do not include a period at the end"
+                         when "conventional"
+                           "You are a commit message generator that MUST follow the conventional commit format: <type>(<scope>): <description>\n" \
+                           "Valid types are: #{commit_types}\n" \
+                           "Rules:\n" \
+                           "1. ALWAYS start with a type from the list above\n" \
+                           "2. ALWAYS use the exact format <type>(<scope>): <description>\n" \
+                           "3. Keep the message under 72 characters\n" \
+                           "4. Use lowercase\n" \
+                           "5. Use present tense\n" \
+                           "6. Be descriptive but concise\n" \
+                           "7. Do not include a period at the end"
+                         else
+                           "You are an expert in writing clear and concise git commit messages..."
+                         end
 
-        commit_types = %w[feat fix docs style refactor test chore perf ci build revert].join('|')
         user_message = if scope
-                         "Generate ONLY a conventional commit message for this diff. The message MUST start with one of these types: #{commit_types}\n\n" \
-                         "Format: <type>: <description>\n" \
-                         "Example: feat: add user authentication\n\n" \
-                         "Rules:\n" \
-                         "1. Keep the commit message under 72 characters\n" \
-                         "2. Use lowercase\n" \
-                         "3. Use present tense\n" \
-                         "4. Make it unique and different from previous suggestions\n" \
-                         "5. MUST start with one of the valid types followed by a colon\n\n" \
-                         "Here's the diff:\n#{diff}" +
-                           previous_suggestions_prompt
+                         "Generate a conventional commit message with scope '#{scope}' for this diff:\n\n#{diff}"
                        else
-                         "Generate ONLY a conventional commit message for this diff. The message MUST start with one of these types: #{commit_types}\n\n" \
-                         "Format: <type>: <description>\n" \
-                         "Example: feat: add user authentication\n\n" \
-                         "Rules:\n" \
-                         "1. Keep the commit message under 72 characters\n" \
-                         "2. Use lowercase\n" \
-                         "3. Use present tense\n" \
-                         "4. Make it unique and different from previous suggestions\n" \
-                         "5. MUST start with one of the valid types followed by a colon\n\n" \
-                         "Here's the diff:\n#{diff}" +
-                           previous_suggestions_prompt
+                         "Generate a #{style} commit message for this diff:\n\n#{diff}"
                        end
 
         payload = {
@@ -253,7 +303,7 @@ module GitAuto
           temperature: temperature,
           top_k: 50,
           top_p: 0.9,
-          system: prompt,
+          system: system_message,
           messages: [
             {
               role: "user",
@@ -272,10 +322,10 @@ module GitAuto
         # log_api_response(response.body)
 
         response = HTTP.headers({
-                                "Content-Type" => "application/json",
-                                "x-api-key" => api_key,
-                                "anthropic-version" => "2023-06-01"
-                              }).post(CLAUDE_API_URL, json: payload)
+                                  "Content-Type" => "application/json",
+                                  "x-api-key" => api_key,
+                                  "anthropic-version" => "2023-06-01"
+                                }).post(CLAUDE_API_URL, json: payload)
 
         message = handle_response(response)
         message = message.downcase.strip
@@ -292,6 +342,8 @@ module GitAuto
           "simple commit message"
         when :scope, "scope"
           "commit scope suggestion"
+        when :minimal, "minimal"
+          "minimal commit message"
         else
           "commit message"
         end
@@ -309,6 +361,7 @@ module GitAuto
               # 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")
@@ -324,9 +377,7 @@ module GitAuto
 
             message = lines.first
 
-            if message.nil? || !message.match?(/^[a-z]+:/)
-              raise Error, "No valid commit message found in response"
-            end
+            raise Error, "No valid commit message found in response" if message.nil? || !message.match?(/^[a-z]+:/)
 
             message
           end
@@ -348,18 +399,18 @@ module GitAuto
       end
 
       def infer_scope_from_diff(diff)
-        files = diff.scan(/^diff --git.*?b\/(.+)$/).flatten
+        files = diff.scan(%r{^diff --git.*?b/(.+)$}).flatten
         return nil if files.empty?
 
         scopes = files.map do |file|
-          parts = file.split('/')
+          parts = file.split("/")
           if parts.length > 1
             parts.first
           else
-            basename = File.basename(file, '.*')
+            basename = File.basename(file, ".*")
 
             if basename =~ /^(.*?)\d*$/
-              $1
+              ::Regexp.last_match(1)
             else
               basename
             end
@@ -367,19 +418,19 @@ module GitAuto
         end.compact
 
         # Filter out overly generic scopes
-        scopes.reject! { |s| %w[rb js py ts css html md].include?(s) }
+        scopes.reject! { |s| ["rb", "js", "py", "ts", "css", "html", "md"].include?(s) }
         return nil if scopes.empty?
 
         # Return the most common scope
         scope = scopes.group_by(&:itself)
-                     .max_by { |_, group| group.length }
-                     &.first
+          .max_by { |_, group| group.length }
+          &.first
 
         # Convert to snake_case if needed
         scope&.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-             &.gsub(/([a-z\d])([A-Z])/, '\1_\2')
-             &.tr('-', '_')
-             &.downcase
+          &.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          &.tr("-", "_")
+          &.downcase
       end
     end
   end

data/lib/git_auto/services/git_service.rb

@@ -26,7 +26,7 @@ module GitAuto
 
       def get_commit_history(limit = nil)
         validate_git_repository!
-        format = '%H%n%s%n%an%n%aI'
+        format = "%H%n%s%n%an%n%aI"
         command = ["log", "--pretty=format:#{format}", "--no-merges"]
         command << "-#{limit}" if limit
 
@@ -55,20 +55,23 @@ module GitAuto
       private
 
       def validate_git_repository!
-        unless File.directory?(".git")
-          raise Error, "Not a git repository (or any of the parent directories)"
-        end
+        return if File.directory?(".git")
+
+        raise Error, "Not a git repository (or any of the parent directories)"
       end
 
       def validate_staged_changes!
-        unless has_staged_changes?
-          raise Error, "No changes staged for commit"
-        end
+        return if has_staged_changes?
+
+        raise Error, "No changes staged for commit"
       end
 
       def has_staged_changes?
-        !execute_git_command("diff", "--cached", "--quiet")
-        $CHILD_STATUS.exitstatus == 1
+        # git diff --cached --quiet returns:
+        # - exit status 0 (success) if there are no changes
+        # - exit status 1 (failure) if there are changes
+        system("git diff --cached --quiet")
+        !$CHILD_STATUS.success?
       end
 
       def is_clean?
@@ -85,9 +88,7 @@ module GitAuto
       def execute_git_command(*args)
         output = IO.popen(["git", *args], err: [:child, :out], &:read)
 
-        unless $CHILD_STATUS.success?
-          raise Error, "Git command failed: git #{args.join(' ')}\n#{output}"
-        end
+        raise Error, "Git command failed: git #{args.join(" ")}\n#{output}" unless $CHILD_STATUS.success?
 
         output
       end

data/lib/git_auto/validators/commit_message_validator.rb

@@ -20,6 +20,12 @@ module GitAuto
         "revert" => "Reverts a previous commit"
       }.freeze
 
+      MINIMAL_COMMIT_PATTERN = /
+        ^(?<type>#{TYPES.keys.join("|")})           # Commit type
+        :\s                                         # Colon and space separator
+        (?<description>.+)                          # Commit description
+      /x
+
       CONVENTIONAL_COMMIT_PATTERN = %r{
         ^(?<type>#{TYPES.keys.join("|")})           # Commit type
         (\((?<scope>[a-z0-9/_-]+)\))?               # Optional scope in parentheses
@@ -71,12 +77,12 @@ module GitAuto
 
         errors << "Header exceeds #{HEADER_MAX_LENGTH} characters" if header.length > HEADER_MAX_LENGTH
 
-        # Validate header format for conventional commits
-        valid_types = TYPES.keys.join('|')
-        pattern = %r{^(?:#{valid_types})\([a-z0-9/_-]+\)?: .+$}
+        # Validate header format for conventional and minimal commits
+        minimal_pattern = MINIMAL_COMMIT_PATTERN
+        conventional_pattern = CONVENTIONAL_COMMIT_PATTERN
 
-        unless pattern.match?(header)
-          errors << "Header must follow conventional commit format: <type>(<scope>): <description>"
+        unless minimal_pattern.match?(header) || conventional_pattern.match?(header)
+          errors << "Header must follow either minimal format: <type>: <description> or conventional format: <type>(<scope>): <description>"
         end
 
         # Suggest using lowercase for consistency

data/lib/git_auto/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_auto
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Guillermo Diaz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor