commitgpt 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a73fe2965f7f3fedb44a5173fcd2dfb888c909c3ea275bed72ae1474f6bfe7cc
+  data.tar.gz: 22388d33280bd6c90a4febff1964eab35b558befc777465374b420567d080e35
+SHA512:
+  metadata.gz: 5d0af4dacb622f9c893bafadf5bafe45a48fdd7664a29c804e122ae9cddafea13d7d8a61a0345215cffe6552e15ba4e8e6d0888515a12527b7e79f7305a3e238
+  data.tar.gz: bc785e338d404f12f8d6e5b94659ae4aa8dc9301507722ec78b73f7f85ea7824e2e8ce718563fa5a1cf69c1c56d62e0ad8cb8f66646418b56865ebc9a061be4a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 160
+
+MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 100

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at p.zhang@iot-venture.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in commitgpt.gemspec
+gemspec
+
+gem "httparty"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "thor"

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    commitgpt (0.1.2)
+      httparty (~> 0.18)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  commitgpt!
+  httparty
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  thor
+
+BUNDLED WITH
+   2.4.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ZPVIP
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Peng Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+<div align="center">
+  <div>
+    <h1 align="center">Commit GPT</h1>
+  </div>
+	<p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
+</div>
+
+---
+
+## Installation
+```bash
+$ gem install commitgpt
+```
+
+## Usage
+### API key
+grab your [OpenAI key](https://openai.com/api/) and add it as an env variable.
+```bash
+$ export OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxx
+```
+It's recommended to add the first line to your `.zshrc` or `.bashrc` so it persists instead of having to define it in each terminal session.
+    
+### aicm
+`aicm` is an abbreviation for `AI commits`, after `git add .` add your file to stage, then use `aicm` to commit with an AI generated commit message.
+```bash
+$ cd /path/to/your/repo
+$ git add .
+$ aicm
+
+▲ Welcome to AI Commits!
+▲   Generating your AI commit message...
+
+▲ Commit message: git commit -am "Update README.md with contribution instructions and OpenAI API key instructions."
+
+▲ Do you want to commit this message? [y/n]
+[main c082637] Update README.md with contribution instructions and OpenAI API key instructions.
+ 4 files changed, 24 insertions(+), 19 deletions(-)
+```
+
+## Special Thanks
+I used chatGPT to convert `AICommits`(JS) to `CommitGPT`(Ruby). Thanks to [https://github.com/Nutlope/aicommits](https://github.com/Nutlope/aicommits)   
+
+## How it works
+This CLI tool runs a git diff command to grab all the latest changes, sends this to OpenAI's GPT-3, then returns the AI generated commit message. I also want to note that it does cost money since GPT-3 generations aren't free. However, OpenAI gives folks $18 of free credits and commit message generations are cheap so it should be free for a long time.
+
+## Limitations
+Only supports git diffs of up to 200 lines of code for now
+The generated commit message can't be edited yet, but you can choose `n` and copy the commit command and edit it manually.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ZPVIP/commitgpt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ZPVIP/commitgpt/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CommitGpt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ZPVIP/commitgpt/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/aicm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "commitgpt/cli"
+CommitGpt::CLI.start

data/lib/commitgpt/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "thor"
+require "commitgpt/commit_ai"
+
+module CommitGpt
+  # CommitGpt CLI
+  class CLI < Thor
+    default_task :aicm
+
+    desc "aicm", "AI commits for you!"
+    def aicm
+      CommitGpt::CommitAi.new.aicm
+    end
+  end
+end

data/lib/commitgpt/commit_ai.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+require "io/console"
+require_relative "string"
+
+# CommitGpt based on GPT-3
+module CommitGpt
+  # Commit AI roboter based on GPT-3
+  class CommitAi
+    OPENAI_API_KEY = ENV.fetch("OPENAI_API_KEY", nil)
+    def aicm
+      exit(1) unless welcome
+      diff = git_diff || exit(1)
+      ai_commit_message = message(diff) || exit(1)
+      puts `git commit -m "#{ai_commit_message}" && echo && echo && git log -1 && echo` if confirmed
+    end
+
+    private
+
+    def confirmed
+      puts "▲ Do you want to commit this message? [y/n]".magenta
+
+      use_commit_message = nil
+      use_commit_message = $stdin.getch.downcase until use_commit_message =~ /\A[yn]\z/i
+
+      puts "\n▲ Commit message has not been commited.\n".red if use_commit_message == "n"
+
+      use_commit_message == "y"
+    end
+
+    def message(diff = nil)
+      prompt = "I want you to act like a git commit message writer. I will input a git diff and your job is to convert it into a useful " \
+               "commit message. Do not preface the commit with anything, use the present tense, return a complete sentence, " \
+               "and do not repeat yourself: #{diff}"
+
+      puts "▲   Generating your AI commit message...\n".gray
+      ai_commit_message = generate_commit(prompt)
+      return nil if ai_commit_message.nil?
+
+      puts "#{"▲ Commit message: ".green}git commit -am \"#{ai_commit_message}\"\n\n"
+      ai_commit_message
+    end
+
+    def git_diff
+      diff = `git diff --cached . ":(exclude)Gemfile.lock" ":(exclude)package-lock.json" ":(exclude)yarn.lock" ":(exclude)pnpm-lock.yaml"`.chomp
+
+      if diff.empty?
+        puts "▲ No staged changes found. Make sure there are changes and run `git add .`".red
+        return nil
+      end
+
+      # Accounting for GPT-3's input req of 4k tokens (approx 8k chars)
+      if diff.length > 8000
+        puts "▲ The diff is too large to write a commit message.".red
+        return nil
+      end
+
+      diff
+    end
+
+    def welcome
+      puts "\n▲ Welcome to AI Commits!".green
+
+      if OPENAI_API_KEY.nil?
+        puts "▲ Please save your OpenAI API key as an env variable by doing 'export OPENAI_API_KEY=YOUR_API_KEY'".red
+        return false
+      end
+
+      begin
+        `git rev-parse --is-inside-work-tree`
+      rescue StandardError
+        puts "▲ This is not a git repository".red
+        return false
+      end
+
+      true
+    end
+
+    def generate_commit(prompt = "")
+      payload = {
+        model: "text-davinci-003", prompt: prompt, temperature: 0.7, top_p: 1,
+        frequency_penalty: 0, presence_penalty: 0, max_tokens: 200, stream: false, n: 1
+      }
+
+      begin
+        response = HTTParty.post("https://api.openai.com/v1/completions",
+                                 headers: { "Authorization" => "Bearer #{OPENAI_API_KEY}",
+                                            "Content-Type" => "application/json", "User-Agent" => "Ruby/#{RUBY_VERSION}" },
+                                 body: payload.to_json)
+
+        puts "#{response.inspect}\n"
+
+        ai_commit = response["choices"][0]["text"]
+      rescue StandardError
+        puts "▲ There was an error with the OpenAI API. Please try again later.".red
+        return nil
+      end
+
+      ai_commit.gsub(/(\r\n|\n|\r)/, "")
+    end
+  end
+end

data/lib/commitgpt/string.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Open String to add color
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def gray
+    "\e[90m#{self}\e[0m"
+  end
+
+  def magenta
+    "\e[35m#{self}\e[0m"
+  end
+end

data/lib/commitgpt/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommitGpt
+  VERSION = "0.1.2"
+end

data/lib/commitgpt.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "commitgpt/version"
+require_relative "commitgpt/commit_ai"
+
+module CommitGpt
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: commitgpt
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Peng Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A CLI that writes your git commit messages for you with AI. Never write
+  a commit message again.
+email:
+- zpregister@gmail.com
+executables:
+- aicm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/aicm
+- lib/commitgpt.rb
+- lib/commitgpt/cli.rb
+- lib/commitgpt/commit_ai.rb
+- lib/commitgpt/string.rb
+- lib/commitgpt/version.rb
+homepage: https://github.com/ZPVIP/commitgpt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ZPVIP/commitgpt
+  source_code_uri: https://github.com/ZPVIP/commitgpt
+  changelog_uri: https://github.com/ZPVIP/commitgpt/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A CLI AI that writes git commit messages for you.
+test_files: []