committer 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dce742b36edfa9cef8ad7811bccfef3ca049a91a92cd05264b4004423a1afb9
-  data.tar.gz: 50c8ff360e6905279969af7537e2b6e4cd4f918fec61a65ec1b9333e943906e0
+  metadata.gz: f495af607b9c66c6b3526af94a5d9792441dc84f6bf09c872586d70940ac6cb8
+  data.tar.gz: 3b203eedb9030d65417c74c41c2535ca76230836a612033852703476bcfc2e86
 SHA512:
-  metadata.gz: a9b64954d73434cb9c095b32426f673fe544d23d1d1b0bf74da1ab29b700f77e1a7b3b2d5cd9d571d4e005b706d0369f08666317b521996d18145c6fd2224f6a
-  data.tar.gz: e453d6be97c3ab39aa2fc19c13236477d3b6aed625841e2e2d6035d435adda196ab83353e4763788858e0e4ee328a6f01fd8423412b86679a373648f1b776f45
+  metadata.gz: 28b144c3f80ba381a8c3b00208d8ed92e9d8a47e7e2e21c86eb4c904699ecbd1711907a5bccd01227f6c7bb3c4a336adc199813c5590321e7d8b420891c35fb0
+  data.tar.gz: 597f5f6db243a56f05c285377b6b8cbaa44f1ffebc300ce2febabf7945179346a3db9d4f1afaadcb92e1ca9141cd61012dfdda2a32dfed18c72d0c52747ce71c

data/bin/committer

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require_relative '../lib/committer/config'
+require_relative '../lib/committer/config/accessor'
 require_relative '../lib/committer/commit_generator'
 require_relative '../lib/committer/commands'
 

data/lib/clients/claude_client.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'httparty'
-require_relative '../committer/config'
+require_relative '../committer/config/accessor'
 
 module Clients
   # Claude API client for communicating with Anthropic's Claude model
@@ -12,7 +12,7 @@ module Clients
     class ConfigError < StandardError; end
 
     def initialize
-      @config = Committer::Config.load
+      @config = Committer::Config::Accessor.instance
 
       return unless @config['api_key'].nil? || @config['api_key'].empty?
 

data/lib/committer/commands/default.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../git_helper'
+
 module Committer
   module Commands
     class Default
@@ -10,11 +12,7 @@ module Committer
         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
+        Committer::GitHelper.commit(summary, body)
       end
 
       def self.execute(_args)

data/lib/committer/commands/setup.rb

@@ -1,10 +1,15 @@
 # frozen_string_literal: true
 
+require_relative '../config/writer'
+require_relative '../config/constants'
+
 module Committer
   module Commands
     class Setup
       def self.execute(_args)
-        Committer::Config.setup
+        config_dir = Committer::Config::Constants::CONFIG_DIR
+        writer = Committer::Config::Writer.new(config_dir)
+        writer.setup
         exit 0
       end
     end

data/lib/committer/commands/setup_git_hook.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../git_helper'
+
 module Committer
   module Commands
     class SetupGitHook
@@ -29,7 +31,7 @@ module Committer
       end
 
       def self.validate_git_root
-        git_toplevel = `git rev-parse --show-toplevel`.strip
+        git_toplevel = Committer::GitHelper.repo_root
         current_dir = Dir.pwd
         return if git_toplevel == current_dir
 

data/lib/committer/commit_generator.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'open3'
 require 'httparty'
 require 'yaml'
-require_relative 'config'
+require_relative 'config/accessor'
 require_relative 'prompt_templates'
 require_relative '../clients/claude_client'
+require_relative 'git_helper'
 
 module Committer
   class CommitGenerator
@@ -17,38 +17,24 @@ module Committer
     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
+        Committer::PromptTemplates.build_prompt_summary_only
       else
-        Committer::PromptTemplates::SUMMARY_AND_BODY
+        Committer::PromptTemplates.build_prompt_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
+      Committer::GitHelper.staged_diff
+    rescue Committer::Error => e
+      puts e.message
+      exit 1
     end
 
     def parse_response(response)

data/lib/committer/committer_errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Committer
+  # Base error class for all Committer errors
+  class Error < StandardError; end
+
+  # Configuration management for the Committer gem
+  class ConfigErrors
+    class BaseError < StandardError; end
+
+    # Request Processing Errors
+    class FormatError < BaseError; end
+    class NotSetup < BaseError; end
+  end
+end

data/lib/committer/config/accessor.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'singleton'
+require_relative '../committer_errors'
+require_relative 'constants'
+require_relative '../git_helper'
+
+module Committer
+  # Configuration management for the Committer gem
+  module Config
+    class Accessor
+      include Singleton
+
+      def initialize
+        @config = load_config
+      end
+
+      # Accessor for the loaded config
+      def [](key)
+        @config[key.to_sym] || @config[key.to_s]
+      end
+
+      # Get the entire config hash
+      def to_h
+        @config.dup
+      end
+
+      def load_config
+        # Load configs from both locations and merge them
+        home_config = load_config_from_path(Committer::Config::Constants::CONFIG_FILE)
+        git_root_config = load_config_from_git_root
+        raise Committer::ConfigErrors::NotSetup if home_config.empty? && git_root_config.empty?
+
+        # Merge configs with git root taking precedence
+        home_config.merge(git_root_config)
+      end
+
+      def load_config_from_path(path)
+        return {} unless File.exist?(path)
+
+        result = YAML.load_file(path)
+        raise Committer::ConfigErrors::FormatError, 'Config file must be a YAML hash' unless result.is_a?(Hash)
+
+        result
+      end
+
+      def load_file_from_path(path)
+        return '' unless File.exist?(path)
+
+        File.read(path)
+      end
+
+      def load_formatting_rules
+        git_root = Committer::GitHelper.repo_root
+        unless git_root.empty?
+          formatting_rules_git_path = File.join(git_root, '.committer',
+                                                Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+        end
+
+        git_path_contents = load_file_from_path(formatting_rules_git_path) if formatting_rules_git_path
+
+        return git_path_contents unless git_path_contents.empty?
+
+        home_path = File.join(Committer::Config::Constants::CONFIG_DIR,
+                              Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+
+        home_path_contents = load_file_from_path(home_path)
+
+        return home_path_contents unless home_path_contents.empty?
+
+        default_path = File.join(Committer::Config::Constants::DEFAULT_PROMPT_PATH,
+                                 Committer::Config::Constants::FORMATTING_RULES_FILE_NAME)
+        load_file_from_path(default_path)
+      end
+
+      def load_config_from_git_root
+        git_root = Committer::GitHelper.repo_root
+        return {} if git_root.empty?
+
+        git_config_file = File.join(git_root, '.committer', 'config.yml')
+        load_config_from_path(git_config_file)
+      rescue StandardError
+        {}
+      end
+
+      # Force reload configuration (useful for testing)
+      def reload
+        @config = load_config
+      end
+
+      # Class method for reload
+      def self.reload
+        instance.reload
+      end
+    end
+  end
+end

data/lib/committer/config/constants.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Committer
+  module Config
+    module Constants
+      CONFIG_DIR = File.join(Dir.home, '.committer')
+      CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
+      FORMATTING_RULES_FILE_NAME = 'formatting_rules.txt'
+      DEFAULT_PROMPT_PATH = File.join(File.dirname(__FILE__), '..')
+      CONFIG_FILE_NAME = 'config.yml'
+      DEFAULT_CONFIG = {
+        'api_key' => nil,
+        'model' => 'claude-3-7-sonnet-20250219',
+        'scopes' => nil
+      }.freeze
+    end
+  end
+end

data/lib/committer/config/writer.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'fileutils'
+require_relative '../committer_errors'
+require_relative 'constants'
+
+module Committer
+  module Config
+    class Writer
+      attr_reader :config_dir
+
+      def initialize(config_dir)
+        @config_dir = config_dir
+      end
+
+      def config_file
+        File.join(@config_dir, Committer::Config::Constants::CONFIG_FILE_NAME)
+      end
+
+      def setup
+        create_default_config
+        create_sample_formatting_rules
+      end
+
+      def write_config_file(file_path, contents)
+        FileUtils.mkdir_p(@config_dir)
+        if File.exist?(file_path)
+          puts "Config file already exists at #{config_file}, skipping write"
+          false
+        else
+          File.write(file_path, contents)
+          true
+        end
+      end
+
+      def create_sample_formatting_rules
+        default_formatting_rules = File.read(File.join(Committer::Config::Constants::DEFAULT_PROMPT_PATH,
+                                                       Committer::Config::Constants::FORMATTING_RULES_FILE_NAME))
+        formatting_rules_file = File.join(@config_dir,
+                                          "#{Committer::Config::Constants::FORMATTING_RULES_FILE_NAME}.sample")
+        wrote_file = write_config_file(formatting_rules_file, default_formatting_rules)
+        nil unless wrote_file
+      end
+
+      def create_default_config
+        wrote_file = write_config_file(config_file, Committer::Config::Constants::DEFAULT_CONFIG.to_yaml)
+        return unless wrote_file
+
+        puts 'Created config file at:'
+        puts config_file
+        puts "\nPlease edit this file to add your Anthropic API key."
+        puts 'Example config format:'
+        puts '---'
+        puts 'api_key: your_api_key_here'
+        puts 'model: claude-3-7-sonnet-20250219'
+        puts 'scopes:'
+        puts '  - feature'
+        puts '  - api'
+        puts '  - ui'
+      end
+    end
+  end
+end

data/lib/committer/formatting_rules.txt

@@ -0,0 +1,19 @@
+# Formatting rules for message
+Message should be formatted according to conventional commits
+
+## When scopes are available:
+<type>(<scope>): <description>
+
+# Formatting Rules
+## When scopes are not available:
+<type>: <description>
+
+# Types:
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code
+- refactor: A code change that neither fixes a bug nor adds a feature
+- perf: A code change that improves performance
+- test: Adding missing tests or correcting existing tests
+- chore: Changes to the build process or auxiliary tools

data/lib/committer/git_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Committer
+  # Helper class for git operations
+  class GitHelper
+    class << self
+      def commit(summary, body = nil)
+        if body
+          system('git', 'commit', '-m', summary, '-m', body, '-e')
+        else
+          system('git', 'commit', '-m', summary, '-e')
+        end
+      end
+
+      def repo_root
+        `git rev-parse --show-toplevel`.strip
+      end
+
+      def staged_diff
+        stdout, stderr, status = Open3.capture3('git diff --staged')
+        raise Committer::Error, "Failed to get git diff: #{stderr}" unless status.success?
+
+        stdout
+      end
+    end
+  end
+end

data/lib/committer/prompt_templates.rb

@@ -2,82 +2,71 @@
 
 module Committer
   module PromptTemplates
-    SUMMARY_ONLY = <<~PROMPT
-      Below is a git diff of staged changes. Please analyze it and create a commit message following the Conventional Commits format with ONLY a summary line (NO body):
-
-      Format when scopes are available: <type>(<scope>): <description>
-      Format when no scopes are available: <type>: <description>
-
-      Types:
-      - feat: A new feature
-      - fix: A bug fix
-      - docs: Documentation only changes
-      - style: Changes that do not affect the meaning of the code
-      - refactor: A code change that neither fixes a bug nor adds a feature
-      - perf: A code change that improves performance
-      - test: Adding missing tests or correcting existing tests
-      - chore: Changes to the build process or auxiliary tools
-      %<scopes_section>s
-      Guidelines:
-      - Keep the summary under 70 characters
-      - Use imperative, present tense (e.g., "add" not "added" or "adds")
-      - Do not end the summary with a period
-      - Be concise but descriptive in the summary
-      %<scope_instruction>s
-
-      Git Diff:
-      ```
-      %<diff>s
-      ```
-
-      Respond ONLY with the commit message summary line, nothing else.
-    PROMPT
-
-    SUMMARY_AND_BODY = <<~PROMPT
-      Below is a git diff of staged changes. Please analyze it and create a commit message following the Conventional Commits format with a summary line and a detailed body:
-
-      Format when scopes are available:
-      <type>(<scope>): <description>
-
-      <blank line>
-      <body with more detailed explanation>
-
-      Format when no scopes are available:
-      <type>: <description>
-
-      <blank line>
-      <body with more detailed explanation>
-
-
-      Types:
-      - feat: A new feature
-      - fix: A bug fix
-      - docs: Documentation only changes
-      - style: Changes that do not affect the meaning of the code
-      - refactor: A code change that neither fixes a bug nor adds a feature
-      - perf: A code change that improves performance
-      - test: Adding missing tests or correcting existing tests
-      - chore: Changes to the build process or auxiliary tools
-      %<scopes_section>s
-      Guidelines:
-      - Keep the first line (summary) under 70 characters
-      - Use imperative, present tense (e.g., "add" not "added" or "adds")
-      - Do not end the summary with a period
-      - Be concise but descriptive in the summary
-      - Add a blank line between summary and body
-      - Use the body to explain why the change was made, incorporating the user's context
-      - Wrap each line in the body at 80 characters maximum
-      - Break the body into multiple paragraphs if needed
-      %<scope_instruction>s
-
-      User's context for this change: %<commit_context>s
-
-      Git Diff:
-      ```
-      %<diff>s
-      ```
-
-      Respond ONLY with the commit message text (summary and body), nothing else.
-    PROMPT
+    FORMATTING_RULES_PATH = File.join(File.dirname(__FILE__), 'formatting_rules.txt')
+
+    def self.load_formatting_rules
+      File.read(FORMATTING_RULES_PATH)
+    end
+
+    def self.load_scopes
+      scopes = Committer::Config::Accessor.instance[:scopes] || []
+      return 'DO NOT include a scope in your commit message' if scopes.empty?
+
+      scope_list = "\nScopes:\n#{scopes.map { |s| "- #{s}" }.join("\n")}"
+
+      "- Choose an appropriate scope from the list above if relevant to the change \n#{scope_list}"
+    end
+
+    def self.commit_message_guidelines
+      <<~PROMPT
+        #{load_formatting_rules}
+
+        # Formatting rules with body:
+        <message>
+
+        <blank line>
+        <body with more detailed explanation>
+
+        #{load_scopes}
+
+        # Message Guidelines:
+        - Keep the summary under 70 characters
+        - Use imperative, present tense (e.g., "add" not "added" or "adds")
+        - Do not end the summary with a period
+        - Be concise but descriptive in the summary
+
+        # Body Guidelines:
+        - Add a blank line between summary and body
+        - Use the body to explain why the change was made, incorporating the user's context
+        - Wrap each line in the body at 80 characters maximum
+        - Break the body into multiple paragraphs if needed
+
+        Git Diff:
+        ```
+        %<diff>s
+        ```
+      PROMPT
+    end
+
+    def self.build_prompt_summary_only
+      <<~PROMPT
+        Below is a git diff of staged changes. Please analyze it and create a commit message following the formatting rules format with ONLY a message line (NO body):
+
+        #{commit_message_guidelines}
+
+        Respond ONLY with the commit message line, nothing else.
+      PROMPT
+    end
+
+    def self.build_prompt_summary_and_body
+      <<~PROMPT
+        Below is a git diff of staged changes. Please analyze it and create a commit message following the formatting rules format with a summary line and a detailed body:
+
+        #{commit_message_guidelines}
+        User's context for this change: %<commit_context>s
+
+        Respond ONLY with the commit message text (message and body), nothing else.
+      PROMPT
+    end
   end
 end

data/lib/committer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: committer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Sebastien Stettler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -43,7 +43,12 @@ files:
 - lib/committer/commands/setup.rb
 - lib/committer/commands/setup_git_hook.rb
 - lib/committer/commit_generator.rb
-- lib/committer/config.rb
+- lib/committer/committer_errors.rb
+- lib/committer/config/accessor.rb
+- lib/committer/config/constants.rb
+- lib/committer/config/writer.rb
+- lib/committer/formatting_rules.txt
+- lib/committer/git_helper.rb
 - lib/committer/prepare-commit-msg
 - lib/committer/prompt_templates.rb
 - lib/committer/version.rb

data/lib/committer/config.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-require 'fileutils'
-
-module Committer
-  # Configuration management for the Committer gem
-  class Config
-    CONFIG_DIR = File.join(Dir.home, '.committer')
-    CONFIG_FILE = File.join(CONFIG_DIR, 'config.yml')
-    DEFAULT_CONFIG = {
-      'api_key' => nil,
-      'model' => 'claude-3-7-sonnet-20250219',
-      'scopes' => nil
-    }.freeze
-
-    def self.load
-      create_default_config unless File.exist?(CONFIG_FILE)
-      begin
-        YAML.load_file(CONFIG_FILE) || DEFAULT_CONFIG
-      rescue StandardError => e
-        # Use $stdout directly for better test capture
-        $stdout.puts "Error loading config: #{e.message}"
-        DEFAULT_CONFIG
-      end
-    end
-
-    def self.create_default_config
-      FileUtils.mkdir_p(CONFIG_DIR)
-      File.write(CONFIG_FILE, DEFAULT_CONFIG.to_yaml)
-    end
-
-    def self.setup
-      create_default_config
-      puts 'Created config file at:'
-      puts CONFIG_FILE
-      puts "\nPlease edit this file to add your Anthropic API key."
-      puts 'Example config format:'
-      puts '---'
-      puts 'api_key: your_api_key_here'
-      puts 'model: claude-3-7-sonnet-20250219'
-      puts 'scopes:'
-      puts '  - feature'
-      puts '  - api'
-      puts '  - ui'
-    end
-  end
-end