gitlore 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83df2ec7f1aeb81a17d1981379cad4d58b7215b9dcc25efdebbda0efe0953c60
+  data.tar.gz: 40ef139142e1c2d80f63e1ff5df5fa6c900fab2b7f55164b938eb8b6254ebaa6
+SHA512:
+  metadata.gz: 33a1492a53f6503a83547c1c0a0f76984484d55b782ff0e7fdbf84a29e08926a050b8b56cc9c5f95f2e97f6d5b8103f425e437da0794531946f8d0f28fa0945c
+  data.tar.gz: d37d5e112e2a14407a605ba85841e53bc85e45deb8b4546579e1f0215137b9607b338163d93240f40046593c72685092d90735149f6740992d7088366553ae45

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-01
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Johnny 
+
+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,35 @@
+# Gitlore
+
+Gitlore is a simple cli tool to summarize git commits. Run gitlore in a git repository to select the number of commits to summarize, choose the style of the summary, and the model either one from OpenAI or a locally running model via Ollama.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add gitlore
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install gitlore
+```
+
+## Usage
+
+Navigate to a git repository and run gitlore in that directory. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jtheol/gitlore.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/gitlore

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "gitlore"
+
+Gitlore::summarize_git

data/lib/gitlore/version.rb

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

data/lib/gitlore.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require_relative "gitlore/version"
+require "openai"
+require "tty-prompt"
+require "tty-markdown"
+require "pastel"
+require "faraday"
+require "json"
+
+# Gitlore: Summarize git commits with AI.
+# A CLI tool that transforms git commits into natural summaries.
+module Gitlore
+  @prompt = TTY::Prompt.new
+  @pastel = Pastel.new
+
+  def self.client
+    @client ||= OpenAI::Client.new(api_key: ENV["OPENAI_API_KEY"]) if ENV["OPENAI_API_KEY"]
+  end
+
+  def self.choose_openai_model
+    return nil unless client && api_key_error
+
+    begin
+      model_names = client.models.list.data.map(&:id).sort.select do |model|
+        model.include?("gpt")
+      end
+      @prompt.select("Choose an OpenAI model:", model_names, per_page: 10)
+    rescue StandardError => e
+      puts "#{@pastel.red("Error listing models:")} #{e.message}"
+      nil
+    end
+  end
+
+  def self.summarize_git
+    count = @prompt.ask("How many recent commits do you want to summarize?", default: "10").to_i
+    provider = @prompt.select("Choose model provider", %w[openai ollama])
+    style = @prompt.select("Choose summary style:", %w[narrative technical])
+
+    git_log = `git log -n #{count} --pretty=format:"%h %s (%an)"`
+    puts "\n#{@pastel.cyan("🧾 Git Log:")}\n\n#{git_log}\n\n"
+
+    system_prompts = {
+      "narrative" => "You are a skilled storyteller. Given a list of git commits, your task is to craft a concise and
+      engaging narrative that captures the essence of the changes, making them accessible and compelling for a
+      non-technical audience.",
+      "technical" => "You are a senior software engineer. Given a list of git commits, your task is
+      to produce a precise, technically accurate summary of the changes, suitable for other developers and engineers."
+    }
+
+    case provider
+    when "openai"
+      summarize_with_openai(git_log, system_prompts[style])
+    else
+      summarize_with_ollama(git_log, system_prompts[style])
+    end
+  end
+
+  def self.summarize_with_openai(git_log, system_prompt)
+    selected_model = choose_openai_model
+    response = client.chat.completions.create(
+      model: selected_model,
+      messages: [
+        { role: "system", content: system_prompt },
+        { role: "user", content: "Summarize these commits:\n\n#{git_log}" }
+      ],
+      temperature: 0
+    )
+    summary = response.choices[0].message.content
+    puts TTY::Markdown.parse(summary)
+    summary
+  end
+
+  def self.summarize_with_ollama(git_log, system_prompt)
+    conn = Faraday.new(url: "http://localhost:11434") do |f|
+      f.request :json
+      f.adapter Faraday.default_adapter
+    end
+
+    models_response = conn.get("/api/tags")
+    if models_response.status != 200
+      puts "#{@pastel.red("Error:")} Could not fetch models from Ollama server. Check if Ollama is running."
+      return "Failed to connect to Ollama."
+    end
+
+    models = JSON.parse(models_response.body)["models"]
+    model_names = models.map { |m| m["name"] }
+
+    if model_names.empty?
+      puts "#{@pastel.red("Error:")} No models found on Ollama server."
+      return "No models available."
+    end
+
+    local_model = @prompt.select("Choose the local model to use", model_names)
+
+    chat_response = conn.post("/api/chat") do |req|
+      req.headers["Content-Type"] = "application/json"
+      req.body = {
+        model: local_model,
+        messages: [
+          { role: "system", content: system_prompt },
+          { role: "user", content: "Summarize these commits:\n\n#{git_log}" }
+        ],
+        stream: false
+      }
+    end
+
+    if chat_response.status != 200
+      puts "#{@pastel.red("Error:")} Failed to get response from Ollama."
+      return "Failed to get Ollama response."
+    end
+
+    summary = JSON.parse(chat_response.body)["message"]["content"]
+    puts TTY::Markdown.parse(summary)
+    summary
+  end
+
+  def self.api_key_error
+    return true if ENV["OPENAI_API_KEY"]
+
+    puts "#{@pastel.red("Error:")} OPENAI_API_KEY environment variable is not set."
+    false
+  end
+end

data/sig/gitlore.rbs

@@ -0,0 +1,4 @@
+module Gitlore
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: gitlore
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jtheol
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-03 00:00:00.000000000 Z
+dependencies: []
+description: A simple cli tool to create summaries of git commits using LLMs.
+email:
+- jtheol
+executables:
+- gitlore
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gitlore
+- lib/gitlore.rb
+- lib/gitlore/version.rb
+- sig/gitlore.rbs
+homepage: https://github.com/jtheol/gitlore
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A simple cli tool to create summaries of git commits using LLMs.
+test_files: []