ai_refactor 0.3.1 → 0.5.0

data/lib/ai_refactor/run_configuration.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module AIRefactor
+  class RunConfiguration
+    def self.add_new_option(key)
+      self.class.define_method(key) { instance_variable_get("@#{key}") }
+      self.class.define_method("#{key}=") { |v| instance_variable_set("@#{key}", v) }
+    end
+
+    attr_reader :refactor,
+      :input_file_paths,
+      :output_file_path,
+      :output_template_path,
+      :context_file_paths,
+      :context_text,
+      :review_prompt,
+      :prompt,
+      :prompt_file_path,
+      :ai_max_attempts,
+      :ai_model,
+      :ai_temperature,
+      :ai_max_tokens,
+      :ai_timeout,
+      :overwrite,
+      :diff,
+      :verbose,
+      :debug
+
+    def set!(hash)
+      hash.each do |key, value|
+        raise StandardError, "Invalid option: #{key}" unless respond_to?("#{key}=")
+        send("#{key}=", value)
+      end
+    end
+
+    attr_writer :refactor
+
+    # @deprecated
+    def [](key)
+      send(key)
+    end
+
+    def input_file_paths=(paths)
+      @input_file_paths ||= []
+      paths = [paths] unless paths.is_a?(Array)
+      @input_file_paths.concat(paths)
+    end
+
+    attr_writer :output_file_path
+
+    attr_writer :output_template_path
+
+    def context_file_paths=(paths)
+      @context_file_paths ||= []
+      paths = [paths] unless paths.is_a?(Array)
+      @context_file_paths.concat(paths)
+    end
+
+    def context_text=(text)
+      @context_text ||= ""
+      @context_text += text
+    end
+
+    attr_writer :review_prompt
+    attr_writer :prompt
+    attr_writer :prompt_file_path
+
+    def rspec_run_command
+      @rspec_run_command || "bundle exec rspec __FILE__"
+    end
+
+    def minitest_run_command
+      @minitest_run_command || "ruby __FILE__"
+    end
+
+    attr_writer :rspec_run_command
+    attr_writer :minitest_run_command
+
+    def ai_max_attempts=(value)
+      @ai_max_attempts = value || 3
+    end
+
+    def ai_model=(value)
+      @ai_model = value || "gpt-4"
+    end
+
+    def ai_temperature=(value)
+      @ai_temperature = value || 0.7
+    end
+
+    def ai_max_tokens=(value)
+      @ai_max_tokens = value || 1500
+    end
+
+    def ai_timeout=(value)
+      @ai_timeout = value || 60
+    end
+
+    def overwrite=(value)
+      @overwrite = value || "a"
+    end
+
+    attr_writer :diff
+
+    attr_writer :verbose
+
+    attr_writer :debug
+
+    def to_options
+      instance_variables.each_with_object({}) do |var, hash|
+        hash[var.to_s.delete("@").to_sym] = instance_variable_get(var)
+      end
+    end
+  end
+end

data/lib/ai_refactor/{refactors/tests → test_runners}/minitest_runner.rb

@@ -3,9 +3,9 @@
 require "open3"
 
 module AIRefactor
-  module Tests
+  module TestRunners
     class MinitestRunner
-      def initialize(file_path, command_template: "bundle exec rails test __FILE__")
+      def initialize(file_path, command_template: "ruby __FILE__")
         @file_path = file_path
         @command_template = command_template
       end

data/lib/ai_refactor/{refactors/tests → test_runners}/rspec_runner.rb

@@ -3,7 +3,7 @@
 require "open3"
 
 module AIRefactor
-  module Tests
+  module TestRunners
     class RSpecRunner
       def initialize(file_path, command_template: "bundle exec rspec __FILE__")
         @file_path = file_path

data/lib/ai_refactor/{refactors/tests → test_runners}/test_run_diff_report.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AIRefactor
-  module Tests
+  module TestRunners
     class TestRunDiffReport
       def initialize(previous_test_run_result, test_run_result)
         @current = test_run_result

data/lib/ai_refactor/{refactors/tests → test_runners}/test_run_result.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module AIRefactor
-  module Tests
+  module TestRunners
     class TestRunResult
       attr_reader :stdout, :stderr, :example_count, :failure_count, :pending_count
 

data/lib/ai_refactor/version.rb

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

data/lib/ai_refactor.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
-require_relative "ai_refactor/version"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "ai_refactor" => "AIRefactor",
+  "rspec_runner" => "RSpecRunner"
+)
+loader.setup # ready!
 
-require_relative "ai_refactor/logger"
-require_relative "ai_refactor/file_processor"
+module AIRefactor
+  class NoOutputError < StandardError; end
+  # Your code goes here...
+end
 
-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"
+# We eager load here to ensure that all Refactor classes are loaded at startup so they can be registered
+loader.eager_load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_refactor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Use OpenAI's ChatGPT to automate converting Rails RSpec tests to minitest
   (ActiveSupport::TestCase).
 email:
@@ -75,21 +89,41 @@ files:
 - README.md
 - Rakefile
 - ai_refactor.gemspec
+- examples/.gitignore
+- examples/ex1_convert_a_rspec_test_to_minitest.yml
+- examples/ex1_input_spec.rb
+- examples/rails_helper.rb
+- examples/test_helper.rb
 - exe/ai_refactor
 - lib/ai_refactor.rb
-- lib/ai_refactor/base_refactor.rb
+- lib/ai_refactor/cli.rb
+- lib/ai_refactor/command_file_parser.rb
+- lib/ai_refactor/context.rb
 - lib/ai_refactor/file_processor.rb
 - lib/ai_refactor/logger.rb
+- lib/ai_refactor/prompt.rb
+- lib/ai_refactor/prompts/diff.md
+- lib/ai_refactor/prompts/input.md
 - lib/ai_refactor/refactors.rb
-- lib/ai_refactor/refactors/generic.rb
-- lib/ai_refactor/refactors/minitest_to_rspec.rb
-- lib/ai_refactor/refactors/prompts/minitest_to_rspec.md
-- lib/ai_refactor/refactors/prompts/rspec_to_minitest_rails.md
-- lib/ai_refactor/refactors/rspec_to_minitest_rails.rb
-- lib/ai_refactor/refactors/tests/minitest_runner.rb
-- lib/ai_refactor/refactors/tests/rspec_runner.rb
-- lib/ai_refactor/refactors/tests/test_run_diff_report.rb
-- lib/ai_refactor/refactors/tests/test_run_result.rb
+- lib/ai_refactor/refactors/base_refactor.rb
+- lib/ai_refactor/refactors/custom.rb
+- lib/ai_refactor/refactors/minitest/write_test_for_class.md
+- lib/ai_refactor/refactors/minitest/write_test_for_class.rb
+- lib/ai_refactor/refactors/project/write_changelog_from_history.md
+- lib/ai_refactor/refactors/project/write_changelog_from_history.rb
+- lib/ai_refactor/refactors/rails/minitest/rspec_to_minitest.md
+- lib/ai_refactor/refactors/rails/minitest/rspec_to_minitest.rb
+- lib/ai_refactor/refactors/rspec/minitest_to_rspec.md
+- lib/ai_refactor/refactors/rspec/minitest_to_rspec.rb
+- lib/ai_refactor/refactors/ruby/refactor_ruby.md
+- lib/ai_refactor/refactors/ruby/refactor_ruby.rb
+- lib/ai_refactor/refactors/ruby/write_ruby.md
+- lib/ai_refactor/refactors/ruby/write_ruby.rb
+- lib/ai_refactor/run_configuration.rb
+- lib/ai_refactor/test_runners/minitest_runner.rb
+- lib/ai_refactor/test_runners/rspec_runner.rb
+- lib/ai_refactor/test_runners/test_run_diff_report.rb
+- lib/ai_refactor/test_runners/test_run_result.rb
 - lib/ai_refactor/version.rb
 homepage: https://github.com/stevegeek/ai_refactor
 licenses:
@@ -112,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Use AI to convert a Rails RSpec test suite to minitest.

data/lib/ai_refactor/base_refactor.rb

@@ -1,66 +0,0 @@
-# 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
-      file = if options && options[:prompt_file_path]&.length&.positive?
-        options[:prompt_file_path]
-      else
-        File.join(File.dirname(File.expand_path(__FILE__)), "refactors", "prompts", "#{refactor_name}.md")
-      end
-      file.tap do |prompt|
-        raise "No prompt file '#{prompt}' found for #{refactor_name}" unless File.exist?(prompt)
-      end
-    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
-    end
-  end
-end

data/lib/ai_refactor/refactors/generic.rb

@@ -1,113 +0,0 @@
-# frozen_string_literal: true
-
-module AIRefactor
-  module Refactors
-    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
-
-        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
-        )
-
-        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 output_file_path
-        return output_file_path_from_template if output_template_path
-
-        path = options[:output_file_path]
-        return unless path
-
-        if path == true
-          input_file
-        else
-          path
-        end
-      end
-
-      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 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
-  end
-end

data/lib/ai_refactor/refactors/minitest_to_rspec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module AIRefactor
-  module Refactors
-    class MinitestToRspec < BaseRefactor
-      def run
-        raise "Not implemented"
-      end
-    end
-  end
-end

data/lib/ai_refactor/refactors/rspec_to_minitest_rails.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "tests/test_run_result"
-require_relative "tests/rspec_runner"
-require_relative "tests/minitest_runner"
-require_relative "tests/test_run_diff_report"
-
-module AIRefactor
-  module Refactors
-    class RspecToMinitestRails < BaseRefactor
-      def run
-        spec_runner = AIRefactor::Tests::RSpecRunner.new(input_file)
-        logger.verbose "Run spec #{input_file}... (#{spec_runner.command})"
-
-        spec_run = spec_runner.run
-
-        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
-
-        logger.debug "Original test run results:"
-        logger.debug ">> Examples: #{spec_run.example_count}, Failures: #{spec_run.failure_count}, Pendings: #{spec_run.pending_count}"
-
-        output_path = input_file.gsub("_spec.rb", "_test.rb").gsub("spec/", "test/")
-
-        processor = AIRefactor::FileProcessor.new(
-          input_path: input_file,
-          output_path: output_path,
-          prompt_file_path: prompt_file_path,
-          ai_client: ai_client,
-          logger: logger
-        )
-
-        if processor.output_exists?
-          return false unless can_overwrite_output_file?(output_path)
-        end
-
-        logger.verbose "Converting #{input_file}..."
-
-        begin
-          output_content, finished_reason, usage = processor.process!(options) do |content|
-            content.gsub("```", "")
-          end
-        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."
-          logger.warn "Continuing to test the translated file... but it is likely to fail."
-        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
-
-        logger.verbose "Converted #{input_file} to #{output_path}..."
-
-        minitest_runner = AIRefactor::Tests::MinitestRunner.new(processor.output_path)
-
-        logger.verbose "Run generated test file #{output_path} (#{minitest_runner.command})..."
-        test_run = minitest_runner.run
-
-        if test_run.failed?
-          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
-
-        logger.debug "Translated test file results:"
-        logger.debug ">> Runs: #{test_run.example_count}, Failures: #{test_run.failure_count}, Skips: #{test_run.pending_count}"
-
-        report = AIRefactor::Tests::TestRunDiffReport.new(spec_run, test_run)
-
-        if report.no_differences?
-          logger.verbose "Done converting #{input_file} to #{output_path}..."
-          logger.success "No differences found! Conversion worked!"
-          true
-        else
-          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
-    end
-  end
-end