ai_refactor 0.3.1 → 0.4.0

data/lib/ai_refactor/refactors/{prompts/rspec_to_minitest_rails.md → rails/minitest/rspec_to_minitest.md}

@@ -1,8 +1,8 @@
+You are an expert software developer. 
 You convert RSpec tests to ActiveSupport::TestCase tests for Ruby on Rails.
 ActiveSupport::TestCase uses MiniTest under the hood.
 Remember that MiniTest does not support `context` blocks, instead these should be removed and the context
 specified in them should be moved directly into the relevant tests.
-Always enclose the output code in triple backticks (```).
 
 Here are some examples to use as a guide:
 
@@ -42,6 +42,10 @@ subject(:model) { create(:order_state) }
 context "when rejected" do
   before { model.rejected_at = 1.day.ago }
 
+  it "should be not valid" do
+    expect(model).not_to be_valid
+  end
+
   context "with reason and message" do
     before do
       model.rejected_message = reason
@@ -68,6 +72,11 @@ setup do
   @reason = "my reason"
 end
 
+test "when rejected, model should be not valid" do
+  @model.rejected_at = 1.day.ago
+  refute @model.valid?
+end
+
 test "when rejected, with reason and message, model should be valid" do
   @model.rejected_at = 1.day.ago
   @model.rejected_message = @reason
@@ -231,3 +240,33 @@ test "stubs any instance" do
   end
 end
 ```
+
+Example 9) RSpec:
+```
+assert_association @model, :message_thread, :belongs_to
+```
+
+Result 9) minitest:
+
+```
+assert_instance_of MessageThread, @model.message_thread
+```
+
+Example 10) RSpec:
+```
+assert_association @model, :message_thread, :belongs_to, optional: true
+```
+
+Result 10) minitest:
+```
+assoc = @model.reflect_on_association(:message_thread)
+refute assoc.nil?, "no association :message_thread"
+assert_equal :belongs_to, assoc.macro
+assert assoc.options[:optional]
+```
+
+__{{context}}__
+
+Only output the refactored class. Do NOT provide any other description of your work. Always enclose the output code in triple backticks (```).
+
+Convert this Rspec file to minitest:

data/lib/ai_refactor/refactors/rails/minitest/rspec_to_minitest.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module AIRefactor
+  module Refactors
+    module Rails
+      module Minitest
+        class RspecToMinitest < BaseRefactor
+          def run
+            spec_runner = AIRefactor::TestRunners::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 "\nOriginal test run results:"
+            logger.debug ">> Examples: #{spec_run.example_count}, Failures: #{spec_run.failure_count}, Pendings: #{spec_run.pending_count}\n"
+
+            begin
+              result = process!
+            rescue AIRefactor::NoOutputError => _e
+              return false
+            rescue => e
+              logger.error "Failed to convert #{input_file} to Minitest, error: #{e.message}"
+              return false
+            end
+
+            logger.verbose "Converted #{input_file} to #{output_file_path}..." if result
+
+            minitest_runner = AIRefactor::TestRunners::MinitestRunner.new(output_file_path)
+
+            logger.verbose "Run generated test file #{output_file_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_file_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 "\nTranslated test file results:"
+            logger.debug ">> Runs: #{test_run.example_count}, Failures: #{test_run.failure_count}, Skips: #{test_run.pending_count}\n"
+
+            report = AIRefactor::TestRunners::TestRunDiffReport.new(spec_run, test_run)
+
+            if report.no_differences?
+              logger.verbose "Done converting #{input_file} to #{output_file_path}..."
+              logger.success "\nNo differences found! Conversion worked!"
+              true
+            else
+              logger.warn report.diff.colorize(:yellow)
+              logger.verbose "Done converting #{input_file} to #{output_file_path}..."
+              logger.error "\nDifferences found! Conversion failed!", bold: true
+              self.failed_message = "Generated test file run output did not match original RSpec spec run output"
+              false
+            end
+          end
+
+          def self.description
+            "Convert RSpec file to Minitest (for Rails apps)"
+          end
+
+          def default_output_path
+            input_file.gsub("_spec.rb", "_test.rb").gsub("spec/", "test/")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ai_refactor/refactors/rspec/minitest_to_rspec.rb

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

data/lib/ai_refactor/refactors.rb

@@ -2,6 +2,11 @@
 
 module AIRefactor
   module Refactors
+    def register(klass)
+      all[klass.refactor_name] = klass
+    end
+    module_function :register
+
     def get(name)
       all[name]
     end
@@ -12,16 +17,19 @@ module AIRefactor
     end
     module_function :names
 
-    def all
-      @all ||= constants.map { |n| const_get(n) }.select { |c| c.is_a? Class }.each_with_object({}) do |klass, hash|
-        hash[klass.refactor_name] = klass
-      end
+    def descriptions
+      names.map { |n| "\"#{n}\"" }.zip(all.values.map(&:description)).to_h
     end
-    module_function :all
+    module_function :descriptions
 
     def supported?(name)
       names.include?(name)
     end
     module_function :supported?
+
+    def all
+      @all ||= {}
+    end
+    module_function :all
   end
 end

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

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

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.4.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.4.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-25 00:00:00.000000000 Z
+date: 2023-08-15 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:
@@ -77,19 +91,28 @@ files:
 - ai_refactor.gemspec
 - exe/ai_refactor
 - lib/ai_refactor.rb
-- lib/ai_refactor/base_refactor.rb
+- lib/ai_refactor/cli.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/base_refactor.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/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/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:

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