rubofix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e8ee1ffa530c675aa16a7776c5352e7b31fc6f560180d8746703b2a3374edb2
+  data.tar.gz: 7a9e6c9b061b771c9b98a4e567cd9b2cbffffa4226df2548b0f08c9571a21355
+SHA512:
+  metadata.gz: 15734284e3c48fafedea3daf41968975d2d9309721ff32260d53cbbf24a582211855e85fb79f970a86889eb8cb40b5d7c103d4256f6d7ec6b396c82118503553
+  data.tar.gz: 5006c77771dc74861dc7b660813d962e0bbdc6e656015b0536bd5630d7e528c59e0f2bb2d8c446796662531c3ce294866a057602f77d9b3c943b523a86a6a8e3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (C) 2013 Michael Grosser <michael@grosser.it>
+
+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/bin/rubofix

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# enable local usage from cloned repo
+root = File.expand_path('..', __dir__)
+$LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
+
+require "rubofix"
+require "rubofix/cli"
+
+Rubofix::CLI.new.run(ARGV)

data/lib/rubofix/cli.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+class Rubofix
+  class CLI
+    def run(argv)
+      # get config first so we fail fast
+      api_key = ENV.fetch("RUBOFIX_API_KEY")
+      url = ENV.fetch("RUBOFIX_URL", "https://api.openai.com")
+      model = ENV.fetch("MODEL", "gpt-4o-mini")
+      max = Integer(ENV.fetch("MAX", "1"))
+      context = Integer(ENV.fetch("CONTEXT", "0"))
+
+      # autocorrect
+      puts "Attempting to use builtin autocorrect ..."
+      command = "bundle exec rubocop --autocorrect-all #{argv.shelljoin}"
+      puts command if ENV["DEBUG"]
+      output = `#{command}`
+      puts output if ENV["DEBUG"]
+      return 0 if $?.success? # nothing to fix
+
+      # get remaining warnings from rubocop
+      puts "Getting remaining offenses ..."
+      command = "bundle exec rubocop --parallel #{argv.shelljoin}"
+      output = remove_shell_colors(`#{command}`)
+      return 0 if $?.success? # nothing to fix
+
+      # parse rubocop output
+      # output is spam,warnings,spam and we only want warnings
+      # warnings format is warning\nline\npointer but we only need the warning
+      offenses = output.split("\n\n")[2].split("\n").each_slice(3)
+      abort "Unparseable offenses found with command:\n#{command}\n#{output}" if offenses.any? { |w| w.size != 3 }
+      offenses = offenses.map(&:first)
+      abort "No offenses found\n#{output}" if offenses.empty?
+
+      # fix offenses (in reverse order so line numbers stay correct)
+      puts "Fixing MAX=#{max} of #{offenses.size} offenses with MODEL=#{model} ..."
+      rubofix = Rubofix.new(url:, api_key:, model:, context:)
+      offenses.reverse.first(max).each do |warning|
+        rubofix.fix! warning
+      end
+
+      # don't let users that do not read just assume everything is fine
+      if offenses.size > max
+        warn "Not all offenses fixed, run again to fix more"
+        return 1
+      end
+
+      0
+    end
+
+    private
+
+    def remove_shell_colors(string)
+      string.gsub(/\e\[(\d+)(;\d+)*m/, "")
+    end
+  end
+end

data/lib/rubofix/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class Rubofix
+  VERSION = "0.1.0"
+end

data/lib/rubofix.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+class Rubofix
+  def initialize(url:, api_key:, model:, context:)
+    @url = url
+    @api_key = api_key
+    @model = model
+    @context = context
+  end
+
+  def fix!(offense)
+    # parse offense
+    match = offense.match(/(.+):(\d+):\d+: \S+ (\S+?):/)
+    raise "unable to parse offense #{offense}" unless match
+    path = match[1]
+    line_number = Integer(match[2])
+    offense_name = match[3]
+    line, context = lines_from_file(path, line_number)
+
+    # ask openai for a fix
+    prompt =
+      case offense_name
+      when "Gemspec/DevelopmentDependencies"
+        <<~PROMPT
+          Act as ruby code formatter, convert this line taken from a gemspec file into a `gem` method call with `group: :development` for a Gemfile.
+          Never changes meaning, just formatting.
+          - Print only the fixed line, NOTHING ELSE
+          - keep ONLY EXISTING comments
+          - DO NOT ADD NEW COMMENTS
+          - remove leading whitespace
+          #{line}
+        PROMPT
+      else
+        <<~PROMPT
+          Act as ruby code formatter, that never changes meaning, just formatting.
+          This is important production code, nothing except formatting should be changed.
+
+          Fix this rubocop offense: #{offense}
+          - Print only the fixed line, NOTHING ELSE
+          - Do not change the meaning or intent of the code
+          The CONTEXT is as follows:
+          #{context.join("\n")}
+        PROMPT
+      end
+    puts "prompt:#{prompt}" if ENV["DEBUG"]
+    answer = send_to_openai(prompt)
+    puts "answer:\n#{answer}" if ENV["DEBUG"]
+    puts "Fixing #{offense} with:\n#{answer}"
+
+    answer = answer.strip.sub(/\A```ruby\n(.*)\n```\z/m, "\\1") # it always adds these even when asked to not add
+
+    case offense_name
+    when "Gemspec/DevelopmentDependencies"
+      remove_line_in_file(path, line_number)
+      append_line_to_file("Gemfile", answer)
+    else
+      # replace line in file
+      whitespace = line[/\A\s*/]
+      answer = "#{whitespace}#{answer.lstrip}" # it often gets confused and messes up the whitespace
+      replace_line_in_file(path, line_number, answer)
+    end
+  end
+
+  private
+
+  def lines_from_file(file_path, line_number)
+    start_line = [line_number - @context, 1].max
+    end_line = line_number + @context
+
+    lines = File.read(file_path).split("\n", -1)
+    context = lines.each_with_index.map { |l, i| "line #{(i + 1).to_s.rjust(5, " ")}:#{l}" }
+    [lines[line_number - 1], context[start_line - 1..end_line - 1]]
+  end
+
+  def replace_line_in_file(file_path, line_number, new_line)
+    lines = File.read(file_path).split("\n", -1)
+    lines[line_number - 1] = new_line
+    File.write(file_path, lines.join("\n"))
+  end
+
+  def append_line_to_file(path, answer)
+    File.open(path, "a") do |f|
+      f.puts(answer)
+    end
+  end
+
+  def remove_line_in_file(path, line_number)
+    lines = File.read(path).split("\n", -1)
+    lines.delete_at(line_number - 1)
+    File.write(path, lines.join("\n"))
+  end
+
+  def send_to_openai(prompt)
+    uri = URI.parse("#{@url}/v1/chat/completions")
+    request = Net::HTTP::Post.new(uri)
+    request.content_type = "application/json"
+    request["Authorization"] = "Bearer #{@api_key}"
+
+    request.body = JSON.dump(
+      {
+        model: @model,
+        messages: [{ role: "user", content: prompt }],
+        max_tokens: 150
+      }
+    )
+
+    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      http.request(request)
+    end
+    raise "Invalid http response #{response.code}:\n#{response.body}" unless response.is_a?(Net::HTTPSuccess)
+
+    JSON.parse(response.body)["choices"][0]["message"]["content"]
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: rubofix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Grosser
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-27 00:00:00.000000000 Z
+dependencies: []
+description:
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- bin/rubofix
+- lib/rubofix.rb
+- lib/rubofix/cli.rb
+- lib/rubofix/version.rb
+homepage: https://github.com/grosser/rubofix
+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.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Auto fix all rubocop warnings with chatgpt / openai / local llm
+test_files: []