commit_msg_ai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2542791ddb6bec173a486478c5eda34c727dc9f74fb048dd3dd879c987801e5a
+  data.tar.gz: d4248da19ff04e1c1ebeccbe9d0a664c7c0069f9fb57e3436220a57252e1704d
+SHA512:
+  metadata.gz: 34cbf1afa69b5729d4fa977528eb47b4d36d82ac8c32da1638a2406afdcb9e89ccdebe6a306c239fd15516ee31d96a37750ea884f39e7fef2ebc20e856822a6f
+  data.tar.gz: 42d31537fddd5189b4efd114782d93316ef41559fc898aa7aadbc3e07b5169460b9970ead364d780b76f0bd13ce8440576641f1fc4522b7117e4648c6d881a54

data/bin/commit_msg_ai

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/commit_msg_ai/cli'
+CommitMsgAi::Cli.run

data/lib/commit_msg_ai/cli.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'shellwords'
+require 'commit_msg_ai'
+
+module CommitMsgAi
+  # ================================================================================
+  # The `CommitMsgAi::Cli` class provides a command-line interface for generating
+  # commit messages using the Commit Message AI service. It fetches the staged git
+  # diff, communicates with the AI service to generate a commit message, and allows
+  # the user to confirm or edit the message before committing the changes.
+  # ================================================================================
+  class Cli
+    def self.run
+      api_token = ENV.fetch('OPENAI_ACCESS_TOKEN', nil)
+
+      unless api_token
+        puts 'Error: Missing OpenAI API token. Please set OPENAI_ACCESS_TOKEN in your environment variables.'
+        exit 1
+      end
+
+      diff = git_diff
+      if diff.empty?
+        puts 'No staged changes to commit.'
+        exit 0
+      end
+
+      commit_ai = CommitMsgAi::Client.new(api_token)
+      commit_message = commit_ai.generate_commit_message(diff)
+
+      final_message = ask_user_to_confirm_or_edit(commit_message)
+      subject, body = split_commit_message(final_message)
+
+      puts "\nFinal Commit Message:\n\n#{final_message}"
+      puts "\nRunning git commit..."
+      system("git commit -m #{Shellwords.escape(subject)} -m #{Shellwords.escape(body)}")
+    end
+
+    def self.git_diff
+      stdout, stderr, status = Open3.capture3('git diff --staged')
+      raise "Error getting git diff: #{stderr}" unless status.success?
+
+      stdout.strip
+    rescue StandardError => e
+      puts e.message
+      exit 1
+    end
+
+    def self.ask_user_to_confirm_or_edit(commit_message)
+      puts "\nSuggested Commit Message:\n\n#{commit_message}"
+      loop do
+        puts "\nDo you want to:"
+        puts '1. Use this message as-is.'
+        puts '2. Edit this message.'
+        puts '3. Abort the commit process.'
+        print "\nEnter your choice (1, 2, or 3): "
+
+        case gets.strip
+        when '1'
+          return commit_message
+        when '2'
+          puts "\nEnter your custom commit message (leave blank to keep the original):"
+          puts commit_message
+          print '> '
+          edited_message = $stdin.read.strip
+          return edited_message.empty? ? commit_message : edited_message
+        when '3'
+          puts "\nCommit process aborted."
+          exit 0
+        else
+          puts "\nInvalid choice. Please try again."
+        end
+      end
+    end
+
+    def self.split_commit_message(message)
+      lines = message.strip.split("\n", 2)
+      subject = lines[0]
+      body = lines[1..]&.join("\n") || ''
+      [subject, body]
+    end
+  end
+end

data/lib/commit_msg_ai/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommitMsgAi
+  VERSION = '0.1.0'
+end

data/lib/commit_msg_ai.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'openai'
+require_relative 'commit_msg_ai/version'
+
+module CommitMsgAi
+  # ================================================================================
+  # This class interacts with the Commit Message AI service to process and generate
+  # meaningful commit messages based on staged changes in the repository.
+  # ================================================================================
+  class Client
+    def initialize(api_token)
+      @client = OpenAI::Client.new(
+        access_token: api_token,
+        log_errors: true
+      )
+    end
+
+    def generate_commit_message(diff)
+      prompt = generate_prompt(diff)
+      response = @client.chat(
+        parameters: {
+          model: 'gpt-3.5-turbo-0125',
+          messages: [
+            { role: 'system', content: 'You are an assistant generating Git commit messages.' },
+            { role: 'user', content: prompt }
+          ]
+        }
+      )
+      response.dig('choices', 0, 'message', 'content') || 'Error: Unable to generate commit message.'
+    rescue StandardError => e
+      "Error communicating with OpenAI API: #{e.message}"
+    end
+
+    private
+
+    def generate_prompt(diff)
+      <<~PROMPT
+        Act as a professional Ruby on Rails developer who follows "Conventional Commits", please answer the questions.
+        In case you do not know, "Conventional Commits" is as follows:
+        Summary starts here:
+        The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.
+        The commit message should be structured as follows:
+
+        <type>[optional scope]: <description>
+
+        [optional body]
+
+        [optional footer(s)]
+        The commit contains the following structural elements, to communicate intent to the consumers of your library:
+
+        fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
+        feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
+        BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
+        types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others.
+        footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format.
+        Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE). A scope may be provided to a commit’s type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
+
+        Examples
+        Commit message with description and breaking change footer
+        feat: allow provided config object to extend other configs
+
+        BREAKING CHANGE: `extends` key in config file is now used for extending other config files
+        Commit message with ! to draw attention to breaking change
+        feat!: send an email to the customer when a product is shipped
+        Commit message with scope and ! to draw attention to breaking change
+        feat(api)!: send an email to the customer when a product is shipped
+        Commit message with both ! and BREAKING CHANGE footer
+        chore!: drop support for Node 6
+
+        BREAKING CHANGE: use JavaScript features not available in Node 6.
+        Commit message with no body
+        docs: correct spelling of CHANGELOG
+        Commit message with scope
+        feat(lang): add Polish language
+
+        Summary ends here.
+
+        Now, create a concise, professional Git commit message using the "Conventonal Commit" without body and footer based on the following Git diff:
+        #{diff}
+      PROMPT
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: commit_msg_ai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michiharu Ono
+bindir: bin
+cert_chain: []
+date: 2025-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: CLI tool that leverages OpenAI to generate commit messages following
+  the Conventional Commits standard.
+email: michiharuono77@gmail.com
+executables:
+- commit_msg_ai
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/commit_msg_ai
+- lib/commit_msg_ai.rb
+- lib/commit_msg_ai/cli.rb
+- lib/commit_msg_ai/version.rb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  After installing the gem, please run the following command to install Node.js dependencies:
+    npm install -g standard-version
+
+  You can then add a changelog by running:
+    npx standard-version --no-tag
+  This refers the version defined in the package.json file.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Generate commit messages effortlessly using OpenAI.
+test_files: []