ai_refactor 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3b53eb0cea61e83d0d7f5632316be07ced02da11e065626cc5d72329191538
-  data.tar.gz: 9b475208c15ccfaf9185d8c516e62efc28632dc2a6dab6d25beaba28be726278
+  metadata.gz: fa9421b9791dda3c02b930e63d0fa7bd3dc587d121a0b3748a0f9d8c649f98a3
+  data.tar.gz: a5cb385968939847ebb1ceb1d663b1926e410fce0571fa2ab7463440347c0f50
 SHA512:
-  metadata.gz: 97e8c839f7c5e2dd6fc1edc12b6c46f45e99e07701da53c313c7677a159529dffd91a724cf54cb33b0c51d1b84939fb07e94c9dae516906a72030b30f3c9fcaa
-  data.tar.gz: cd4250db8c71efad4daf61ac551b930904a103b573c595cbc3f2a8be7d6b9947576b00bce52f9c8f5858962802eb8827959b8aba5d32193a3732acfb7a108aeb
+  metadata.gz: 6ff997f0533fe95da7f0361789d88b4a73ecd8fbd82a1f54179fbce3b6a3b466c40330ae615a00f850e549212fe2463ba60ca4467cc0d9f65bbd6679f326dff1
+  data.tar.gz: 5898b17ebaa96c24a89cae1ff741a53d3afbb7a6c4844f52a271ddfecc1ebc1923026324601cb98e56b5aed0d673bba5d583d388a7a936e4cc86b272e1858bd8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ai_refactor (0.1.0)
+    ai_refactor (0.3.0)
       colorize (< 2.0)
       open3 (< 2.0)
       ruby-openai (>= 3.4.0, < 5.0)

data/README.md

@@ -9,7 +9,10 @@ This is based on the assumption that the LLM AIs are pretty good at identifying
 
 ## Available refactors
 
-Currently only one is available:
+Currently available:
+
+- `generic`
+- `rspec_to_minitest_rails`
 
 ### `rspec_to_minitest_rails`
 
@@ -25,21 +28,27 @@ AI Refactor 1 files(s)/dir(s) '["spec/models/my_thing_spec.rb"]' with rspec_to_m
 ====================
 Processing spec/models/my_thing_spec.rb...
 [Run spec spec/models/my_thing_spec.rb... (bundle exec rspec spec/models/my_thing_spec.rb)]
-Do you wish to overwrite test/models/company_buyer_test.rb? (y/n)
+Do you wish to overwrite test/models/my_thing_test.rb? (y/n)
 y
 [Converting spec/models/my_thing_spec.rb...]
 [Generate AI output. Generation attempts left: 3]
 [OpenAI finished, with reason 'stop'...]
 [Used tokens: 1869]
-[Converted spec/models/my_thing_spec.rb to test/models/company_buyer_test.rb...]
-[Run generated test file test/models/company_buyer_test.rb (bundle exec rails test test/models/company_buyer_test.rb)...]
-[Done converting spec/models/my_thing_spec.rb to test/models/company_buyer_test.rb...]
+[Converted spec/models/my_thing_spec.rb to test/models/my_thing_test.rb...]
+[Run generated test file test/models/my_thing_test.rb (bundle exec rails test test/models/my_thing_test.rb)...]
+[Done converting spec/models/my_thing_spec.rb to test/models/my_thing_test.rb...]
 No differences found! Conversion worked!
 Refactor succeeded on spec/models/my_thing_spec.rb
 
 Done processing all files!
 ```
 
+### `generic` (user supplied prompt)
+
+Applies the refactor specified by prompting the AI with the user supplied prompt. You must supply a prompt file with the `-p` option.
+
+The output is written to `stdout`.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/exe/ai_refactor

@@ -14,7 +14,6 @@ supported_names = AIRefactor::Refactors.names
 option_parser = OptionParser.new do |parser|
   parser.banner = "Usage: ai_refactor REFACTOR_TYPE INPUT_FILE_OR_DIR [options]\n\nWhere REFACTOR_TYPE is one of: #{supported_names}\n\n"
 
-  # todo: support for a sort of generic process which uses a custom prompt file
   parser.on("-p", "--prompt PROMPT_FILE", String, "Specify path to a text file that contains the ChatGPT 'system' prompt.") do |f|
     options[:prompt_file_path] = f
   end
@@ -27,11 +26,11 @@ option_parser = OptionParser.new do |parser|
     options[:ai_model] = m
   end
 
-  parser.on(nil, "--temperature TEMP", Float, "Specify the temperature parameter for ChatGPT (default 0.7).") do |p|
+  parser.on("--temperature TEMP", Float, "Specify the temperature parameter for ChatGPT (default 0.7).") do |p|
     options[:ai_temperature] = p
   end
 
-  parser.on(nil, "--max-tokens MAX_TOKENS", Integer, "Specify the max number of tokens of output ChatGPT can generate. Max will depend on the size of the prompt (default 1500)") do |m|
+  parser.on("--max-tokens MAX_TOKENS", Integer, "Specify the max number of tokens of output ChatGPT can generate. Max will depend on the size of the prompt (default 1500)") do |m|
     options[:ai_max_tokens] = m
   end
 
@@ -47,18 +46,23 @@ option_parser = OptionParser.new do |parser|
     options[:debug] = true
   end
 
-  supported_refactors.each do |_name, refactorer|
-    refactorer.command_line_options.each do |option|
-      parser.on(option[:short], option[:long], option[:type], option[:help]) do |o|
-        options[option[:key]] = o
-      end
-    end
-  end
-
   parser.on("-h", "--help", "Prints this help") do
     puts parser
     exit
   end
+
+  parser.separator ""
+
+  supported_refactors.each do |name, refactorer|
+    parser.separator "For refactor type '#{name}':" if refactorer.command_line_options.size.positive?
+    refactorer.command_line_options.each do |option|
+      args = [option[:long], option[:type], option[:help]]
+      args.unshift(option[:short]) if option[:short]
+      parser.on(*args) do |o|
+        options[option[:key]] = o.nil? ? true : o
+      end
+    end
+  end
 end
 
 option_parser.parse!
@@ -88,15 +92,28 @@ end.flatten
 logger.info "AI Refactor #{inputs.size} files(s)/dir(s) '#{input_file_path}' with #{refactorer.refactor_name} refactor\n"
 logger.info "====================\n"
 
-inputs.each do |file|
+return_values = inputs.map do |file|
   logger.info "Processing #{file}..."
 
   refactor = refactorer.new(file, options, logger)
-
-  if refactor.run
-    logger.success "Refactor succeeded on #{file}\n"
+  refactor_returned = refactor.run
+  failed = refactor_returned == false
+  if failed
+    logger.warn "Refactor failed on #{file}\nFailed due to: #{refactor.failed_message}\n"
   else
-    logger.warn "Refactor failed on #{file}\n"
+    logger.success "Refactor succeeded on #{file}\n"
+    if refactor_returned.is_a?(String)
+      logger.info "Refactor #{file} output:\n\n#{refactor_returned}\n\n"
+    end
   end
+  failed ? [file, refactor.failed_message] : true
+end
+
+if return_values.all?(true)
+  logger.success "All files processed successfully!"
+else
+  files = return_values.select { |v| v != true }
+  logger.warn "Some files failed to process:\n#{files.map { |f| "#{f[0]} :\n > #{f[1]}" }.join("\n")}"
 end
+
 logger.info "Done processing all files!"

data/lib/ai_refactor/base_refactor.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module AIRefactor
+  class BaseRefactor
+    attr_reader :input_file, :options, :logger
+    attr_writer :failed_message
+
+    def initialize(input_file, options, logger)
+      @input_file = input_file
+      @options = options
+      @logger = logger
+    end
+
+    def run
+      raise NotImplementedError
+    end
+
+    def failed_message
+      @failed_message || "Reason not specified"
+    end
+
+    private
+
+    def can_overwrite_output_file?(output_path)
+      logger.info "Do you wish to overwrite #{output_path}? (y/n)"
+      answer = $stdin.gets.chomp
+      unless answer == "y" || answer == "Y"
+        logger.warn "Skipping #{input_file}..."
+        self.failed_message = "Skipped as output file already exists"
+        return false
+      end
+      true
+    end
+
+    def prompt_file_path
+      self.class.prompt_file_path
+    end
+
+    def ai_client
+      @ai_client ||= OpenAI::Client.new
+    end
+
+    class << self
+      def command_line_options
+        []
+      end
+
+      def refactor_name
+        name.split("::")
+          .last
+          .gsub(/::/, "/")
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr("-", "_")
+          .downcase
+      end
+
+      def prompt_file_path
+        file = if options[:prompt_file_path]&.length&.positive?
+          options[:prompt_file_path]
+        else
+          File.join(File.dirname(File.expand_path(__FILE__)), "prompts", "#{refactor_name}.md")
+        end
+        file.tap do |prompt|
+          raise "No prompt file '#{prompt}' found for #{refactor_name}" unless File.exist?(prompt)
+        end
+      end
+    end
+  end
+end

data/lib/ai_refactor/file_processor.rb

@@ -7,15 +7,16 @@ module AIRefactor
   class FileProcessor
     attr_reader :file_path, :output_path, :logger
 
-    def initialize(file_path, output_path, prompt_file_path:, ai_client:, logger:)
-      @file_path = file_path
-      @output_path = output_path
+    def initialize(input_path:, prompt_file_path:, ai_client:, logger:, output_path: nil)
+      @file_path = input_path
       @prompt_file_path = prompt_file_path
       @ai_client = ai_client
       @logger = logger
+      @output_path = output_path
     end
 
     def output_exists?
+      return false unless output_path
       File.exist?(output_path)
     end
 
@@ -29,9 +30,13 @@ module AIRefactor
       ]
       content, finished_reason, usage = generate_next_message(messages, prompt, options, options[:ai_max_attempts] || 3)
 
-      if content && content.length > 0
+      content = if content && content.length > 0
         processed = block_given? ? yield(content) : content
-        File.write(output_path, processed)
+        if output_path
+          File.write(output_path, processed)
+          logger.verbose "Wrote output to #{output_path}..."
+        end
+        processed
       end
 
       [content, finished_reason, usage]

data/lib/ai_refactor/refactors/generic.rb

@@ -2,42 +2,114 @@
 
 module AIRefactor
   module Refactors
-    class Generic
-      attr_reader :input_file, :options, :logger
+    class Generic < BaseRefactor
+      def run
+        logger.verbose "Generic refactor to #{input_file}... (using user supplied prompt #{prompt_file_path})"
+        logger.verbose "Write output to #{output_file_path}..." if output_file_path
 
-      def initialize(input_file, options, logger)
-        @input_file = input_file
-        @options = options
-        @logger = logger
-      end
+        processor = AIRefactor::FileProcessor.new(
+          input_path: input_file,
+          prompt_file_path: prompt_file_path,
+          ai_client: ai_client,
+          logger: logger,
+          output_path: output_file_path
+        )
 
-      def run
-        raise "Not implemented"
+        if processor.output_exists?
+          return false unless can_overwrite_output_file?(output_file_path)
+        end
+
+        logger.verbose "Converting #{input_file}..."
+
+        begin
+          output_content, finished_reason, usage = processor.process!(options)
+        rescue => e
+          logger.error "Request to OpenAI failed: #{e.message}"
+          logger.warn "Skipping #{input_file}..."
+          self.failed_message = "Request to OpenAI failed"
+          return false
+        end
+
+        logger.verbose "OpenAI finished, with reason '#{finished_reason}'..."
+        logger.verbose "Used tokens: #{usage["total_tokens"]}".colorize(:light_black) if usage
+
+        if finished_reason == "length"
+          logger.warn "Translation may contain an incomplete output as the max token length was reached. You can try using the '--continue' option next time to increase the length of generated output."
+        end
+
+        if !output_content || output_content.length == 0
+          logger.warn "Skipping #{input_file}, no translated output..."
+          logger.error "Failed to translate #{input_file}, finished reason #{finished_reason}"
+          self.failed_message = "AI conversion failed, no output was generated"
+          return false
+        end
+
+        output_file_path ? true : output_content
       end
 
       private
 
-      def ai_client
-        @ai_client ||= OpenAI::Client.new
-      end
+      def output_file_path
+        return output_file_path_from_template if output_template_path
 
-      class << self
-        def command_line_options
-          []
+        path = options[:output_file_path]
+        return unless path
+
+        if path == true
+          input_file
+        else
+          path
         end
+      end
 
-        def refactor_name
-          name.split("::")
-            .last
-            .gsub(/::/, "/")
-            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-            .tr("-", "_")
-            .downcase
+      def output_template_path
+        options[:output_template_path]
+      end
+
+      def output_file_path_from_template
+        path = output_template_path.gsub("[FILE]", File.basename(input_file))
+          .gsub("[NAME]", File.basename(input_file, ".*"))
+          .gsub("[DIR]", File.dirname(input_file))
+          .gsub("[REFACTOR]", self.class.refactor_name)
+          .gsub("[EXT]", File.extname(input_file))
+        raise "Output template could not be used" unless path.length.positive?
+        path
+      end
+
+      def prompt_file_path
+        specified_prompt_path = options[:prompt_file_path]
+        if specified_prompt_path&.length&.positive?
+          if File.exist?(specified_prompt_path)
+            return specified_prompt_path
+          else
+            logger.error "No prompt file '#{specified_prompt_path}' found"
+          end
+        else
+          logger.error "No prompt file was specified!"
         end
+        exit 1
+      end
 
+      class << self
         def prompt_file_path
-          File.join(File.dirname(File.expand_path(__FILE__)), "prompts", "#{refactor_name}.md")
+          raise "Generic refactor requires prompt file to be user specified."
+        end
+
+        def command_line_options
+          [
+            {
+              key: :output_file_path,
+              long: "--output [FILE]",
+              type: String,
+              help: "Write output to file instead of stdout. If no path provided will overwrite input file (will prompt to overwrite existing files)"
+            },
+            {
+              key: :output_template_path,
+              long: "--output-template TEMPLATE",
+              type: String,
+              help: "Write outputs to files instead of stdout. The template is used to create the output name, where the it can have substitutions, '[FILE]', '[NAME]', '[DIR]', '[REFACTOR]' & '[EXT]'. Eg `[DIR]/[NAME]_[REFACTOR][EXT]` (will prompt to overwrite existing files)"
+            }
+          ]
         end
       end
     end

data/lib/ai_refactor/refactors/minitest_to_rspec.rb

@@ -2,7 +2,7 @@
 
 module AIRefactor
   module Refactors
-    class MinitestToRspec < Generic
+    class MinitestToRspec < BaseRefactor
       def run
         raise "Not implemented"
       end

data/lib/ai_refactor/refactors/rspec_to_minitest_rails.rb

@@ -7,7 +7,7 @@ require_relative "tests/test_run_diff_report"
 
 module AIRefactor
   module Refactors
-    class RspecToMinitestRails < Generic
+    class RspecToMinitestRails < BaseRefactor
       def run
         spec_runner = AIRefactor::Tests::RSpecRunner.new(input_file)
         logger.verbose "Run spec #{input_file}... (#{spec_runner.command})"
@@ -17,6 +17,7 @@ module AIRefactor
         if spec_run.failed?
           logger.warn "Skipping #{input_file}..."
           logger.error "Failed to run #{input_file}, exited with status #{spec_run.exitstatus}. Stdout: #{spec_run.stdout}\n\nStderr: #{spec_run.stderr}\n\n"
+          self.failed_message = "Failed to run RSpec file, has errors"
           return false
         end
 
@@ -26,20 +27,15 @@ module AIRefactor
         output_path = input_file.gsub("_spec.rb", "_test.rb").gsub("spec/", "test/")
 
         processor = AIRefactor::FileProcessor.new(
-          input_file,
-          output_path,
-          prompt_file_path: self.class.prompt_file_path,
+          input_path: input_file,
+          output_path: output_path,
+          prompt_file_path: prompt_file_path,
           ai_client: ai_client,
           logger: logger
         )
 
         if processor.output_exists?
-          logger.info "Do you wish to overwrite #{output_path}? (y/n)"
-          answer = $stdin.gets.chomp
-          unless answer == "y" || answer == "Y"
-            logger.warn "Skipping #{input_file}..."
-            return false
-          end
+          return false unless can_overwrite_output_file?(output_path)
         end
 
         logger.verbose "Converting #{input_file}..."
@@ -51,6 +47,7 @@ module AIRefactor
         rescue => e
           logger.error "Request to OpenAI failed: #{e.message}"
           logger.warn "Skipping #{input_file}..."
+          self.failed_message = "Request to OpenAI failed"
           return false
         end
 
@@ -65,6 +62,7 @@ module AIRefactor
         if !output_content || output_content.length == 0
           logger.warn "Skipping #{input_file}, no translated output..."
           logger.error "Failed to translate #{input_file}, finished reason #{finished_reason}"
+          self.failed_message = "AI conversion failed, no output was generated"
           return false
         end
 
@@ -79,6 +77,7 @@ module AIRefactor
           logger.warn "Skipping #{input_file}..."
           logger.error "Failed to run translated #{output_path}, exited with status #{test_run.exitstatus}. Stdout: #{test_run.stdout}\n\nStderr: #{test_run.stderr}\n\n"
           logger.error "Conversion failed!", bold: true
+          self.failed_message = "Generated test file failed to run correctly"
           return false
         end
 
@@ -95,6 +94,7 @@ module AIRefactor
           logger.warn report.diff.colorize(:yellow)
           logger.verbose "Done converting #{input_file} to #{output_path}..."
           logger.error "Differences found! Conversion failed!", bold: true
+          self.failed_message = "Generated test file run output did not match original RSpec spec run output"
           false
         end
       end

data/lib/ai_refactor/version.rb

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

data/lib/ai_refactor.rb

@@ -6,6 +6,7 @@ require_relative "ai_refactor/logger"
 require_relative "ai_refactor/file_processor"
 
 require_relative "ai_refactor/refactors"
+require_relative "ai_refactor/base_refactor"
 require_relative "ai_refactor/refactors/generic"
 require_relative "ai_refactor/refactors/rspec_to_minitest_rails"
 require_relative "ai_refactor/refactors/minitest_to_rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_refactor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -77,6 +77,7 @@ files:
 - ai_refactor.gemspec
 - exe/ai_refactor
 - lib/ai_refactor.rb
+- lib/ai_refactor/base_refactor.rb
 - lib/ai_refactor/file_processor.rb
 - lib/ai_refactor/logger.rb
 - lib/ai_refactor/refactors.rb