ai_refactor 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ebe9a5f356fd432e2e0fdba9c96bc78ea6e5d9b8f2b98357f7a75bd1a53be35
-  data.tar.gz: 035fb030362ff96600eee4a57939077ae6b1d2c1c0faf2b6f2ec5cfd5c3b8570
+  metadata.gz: ca299458e2af2bc7ba495ce6473e1e6b1824e679893815616a209697178aefbd
+  data.tar.gz: b13da64462ef3f5572a9afebb0020ecdb5adc538b92e7c80b3b6bbd756473f9d
 SHA512:
-  metadata.gz: 764bde690ee5d65522a91e11642e830cb60a1704a20811d00ee522b33b358c36ad7a4193bf437373ce735434fad4f824ddf378ad55c83cce205eeac3311da1f5
-  data.tar.gz: a19722433c2ed1778a45779383a51dbeb21d0f421efc9b41510c581c96318f7b04b5914bfbea4ca155155742a573b9d3c6a3e0e75b1d0eed43b25b19d6081c62
+  metadata.gz: 5714f5535a9a6436beba5a6b33a79a0eb02c095f4ca93a5cdfd794fc231cdcab6341a87565fc8c9f32ef24e1edf35957d5268b48f259c2046f867d722520760a
+  data.tar.gz: d986828235c4f26ba78a443ca267455be12d2b9647b672f7cb8a4f4ce53eed5f02c426f626531a9d567058ad8f3e4a34f0c43072529820ca803719542ea0c9e0

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # AI Refactor Changelog
 
+
+## [0.5.4] - 2024-02-07
+
+### Added
+- Support for built-in command YML files to make it easy to add new refactors
+- Support for specifying context files from gems with `context_file_paths_from_gems:` key in command templates
+- Command to convert Minitest tests to Quickdraw tests
+
+### Changes
+- Default openAI model is now `gpt-4-turbo-preview`
+
+## [0.5.3] - 2024-02-06
+
+### Added
+- Add runner to run steep on inputs after generating RBS
+- Add refactor to write RBS
+
+### Fixed
+- Removed dependency on `dotenv` gems
+- Update openai dependency
+- Improve prompt handling to allow having custom text prompts from commands that can append to build in prompt templates
+- Custom refactor should allow prompt to come from prompt text option
+
+## [0.5.2] - 2023-09-21
+
+### Added
+
+### Fixed
+- Removed `puts`
+
 ## [0.5.1] - 2023-09-21
 
 ### Added

data/Gemfile

@@ -11,7 +11,7 @@ gem "minitest", "~> 5.0"
 
 gem "standard", "~> 1.3"
 
-gem "dotenv"
+gem "steep"
 
 # for the examples
 

data/README.md

@@ -49,8 +49,7 @@ And find the file `examples/ex1_input_test.rb` has been created. Note the proces
 
 If you see an error, then try to run it again, or use a different GPT model.
 
-
-## Available refactors
+## Available refactors & commands
 
 Write your own prompt:
 
@@ -107,6 +106,14 @@ For example, if the input file is `app/stuff/my_thing.rb` the output will be wri
 This refactor can benefit from being passed related files as context, for example, if the class under test inherits from another class,
 then context can be used to provide the parent class.
 
+### `quickdraw/0.1.0/convert_minitest`
+
+Convert Minitest or Test::Unit test suite files to [Quickdraw](https://github.com/joeldrapper/quickdraw) test suite files.
+
+Files, by default, are output to the same directory as the input file but with .test.rb extension (and _test removed).
+
+Note: Quickdraw is still missing some features, so some minitest methods are not converted, for example, Quickdraw does not support setup/teardown just yet.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -134,7 +141,7 @@ Where REFACTOR_TYPE_OR_COMMAND_FILE is either the path to a command YML file, or
     -p, --prompt PROMPT_FILE         Specify path to a text file that contains the ChatGPT 'system' prompt.
     -f, --diffs                      Request AI generate diffs of changes rather than writing out the whole file.
     -C, --continue [MAX_MESSAGES]    If ChatGPT stops generating due to the maximum token count being reached, continue to generate more messages, until a stop condition or MAX_MESSAGES. MAX_MESSAGES defaults to 3
-    -m, --model MODEL_NAME           Specify a ChatGPT model to use (default gpt-4).
+    -m, --model MODEL_NAME           Specify a ChatGPT model to use (default gpt-4-turbo-preview).
         --temperature TEMP           Specify the temperature parameter for ChatGPT (default 0.7).
         --max-tokens MAX_TOKENS      Specify the max number of tokens of output ChatGPT can generate. Max will depend on the size of the prompt (default 1500)
     -t, --timeout SECONDS            Specify the max wait time for ChatGPT response.
@@ -180,7 +187,7 @@ context_text: |
     Some extra info to prepend to the prompt
 diff: true/false (default false)
 ai_max_attempts: max times to generate more if AI does not complete generating (default 3)
-ai_model: ChatGPT model name (default gpt-4)
+ai_model: ChatGPT model name (default gpt-4-turbo-preview)
 ai_temperature: ChatGPT temperature (default 0.7)
 ai_max_tokens: ChatGPT max tokens (default 1500)
 ai_timeout: ChatGPT timeout (default 60)

data/Steepfile

@@ -0,0 +1,27 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname"              # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# A steep target to check our example
+target :examples do
+  signature "examples/outputs"
+  check "examples/ex2_input.rb"
+end

data/ai_refactor.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "colorize", "< 2.0"
   spec.add_dependency "open3", "< 2.0"
-  spec.add_dependency "ruby-openai", ">= 3.4.0", "< 5.0"
+  spec.add_dependency "ruby-openai", ">= 3.4.0", "< 6.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 end

data/commands/quickdraw/0.1.0/convert_minitest.yml

@@ -0,0 +1,194 @@
+# Convert Minitest or Test::Unit test suite files to Quickdraw test suite files.
+#
+# Files are output to the same directory as the input file but with .test.rb extension (and _test removed).
+# Quickdraw is still missing some features, so some minitest methods are not converted. Also
+# Quickdraw does not support setup/teardown just yet.
+
+refactor: ruby/refactor_ruby
+description: Convert Minitest or Test::Unit test suite files to Quickdraw test suite files.
+output_template_path: "[DIR]/[NAME|_test|].test[EXT]"
+context_file_paths_from_gems:
+  quickdraw:
+    - "lib/quickdraw/matchers/boolean.rb"
+    - "lib/quickdraw/matchers/case_equality.rb"
+    - "lib/quickdraw/matchers/change.rb"
+    - "lib/quickdraw/matchers/equality.rb"
+    - "lib/quickdraw/matchers/include.rb"
+    - "lib/quickdraw/matchers/predicate.rb"
+    - "lib/quickdraw/matchers/respond_to.rb"
+    - "lib/quickdraw/matchers/to_be_a.rb"
+    - "lib/quickdraw/matchers/to_have_attributes.rb"
+prompt: |
+  You are an expert Ruby senior software developer. You convert minitest or Test::Unit test suite files to Quickdraw test suite files.
+
+  Quickdraw is a new test framework for Ruby:
+  
+  - Spec-like DSL, but with just five methods: `describe`, `test` and `expect`, `assert`, `refute`. No `context`, `let`, `subject`, `to`, `it`, `is_expected` or `specify`, and you’ll never need to guess whether the next symbol should be a space, a colon, a dot or an underscore.
+  - No chaining on matchers. Rather than chain, the matcher can yield if it wants to allow for more complex matching.
+  - Auto-loaded configuration, so you never need to `require "test_helper"`.
+  - Scoped execution, so you can define methods and constants at the top level without worrying about collisions.
+  - You can define your own matchers, which can be scoped to a specific type of object and they can be overloaded for different types.
+  - Designed to take advantage of all your CPU cores — by default it runs one process per CPU core and two threads per process.
+  - Optional test names — sometimes the code is so clear, you don’t need names.
+  - Make as many expectations as you want in a test. You’ll get a dot for each one to make you feel good about youtself.
+  
+  > [!TIP]
+  > Your test files are executed in an anonymous class, so you can define methods and constants at the top level without worrying about collisions. If you’re testing something that references `Class#name`, you may have to define those classes as fixtures somewhere else.
+  
+  ### `.test`
+  Use the `test` method to define a test. The description is optional — sometimes you don’t need it.
+  
+  ```ruby
+  test { assert true }
+  ```
+  
+  You can pass `skip: true` to skip the test. Skipped tests are still run; they pass if they fail and fail they pass.
+  
+  ```ruby
+  test(skip: true) { assert false }
+  ```
+  
+  ### `.describe`
+  You can optionally wrap tests in any number of `describe` blocks, which can take a description as a string or module/class.
+  
+  ```ruby
+  describe Thing do
+    # your Thing tests here
+  end
+  ```
+  
+  ### `#assert`
+  `assert` takes a value and passes if it’s truthy.
+  
+  ```ruby
+  test "something" do
+    assert true
+  end
+  ```
+  
+  You can pass a custom failure message as a block. Using blocks for the failure messages means we don’t waste time constructing them unless the test fails. You don’t need to worry about expensive failure messages slowing down your tests.
+  
+  ```ruby
+  test "something" do
+    assert(false) { "This is a custom failure message" }
+  end
+  ```
+  
+  ### `#refute`
+  `refute` is just like `assert`, but it passes if the value is falsy.
+  
+  ```ruby
+  test "something" do
+    refute false
+  end
+  ```
+  
+  ### `expect` matchers
+  `expect` takes either a value or a block and returns an expectation object, which you can call matchers on.
+  
+  #### `==` and `!=`
+  
+  ```ruby
+  test "equality" do
+    expect(Thing.foo) == "foo"
+    expect(Thing.bar) != "foo"
+  end
+  ```
+  
+  #### `to_raise`
+  
+  ```ruby
+  test "raises" do
+    expect { Thing.bar! }.to_raise(ArgumentError) do |error|
+      expect(error.message) == "Foo bar"
+    end
+  end
+  ```
+  
+  #### `to_receive`
+  
+  ```ruby
+  test "mocks and spies" do
+    expect(Thing).to_receive(:foo) do |a, b, c|
+      # The block receives arguments and can make assertions about them.
+      expect(a) == 1
+      expect(b) != 1
+      assert(c)
+  
+      # Either return a mock response or call the original via `@super`
+      @super.call
+    end
+  
+    Thing.foo(1, 2, 3)
+  end
+  ```
+  
+  ### Mappings of minitest assertions/expectations to quickdraw
+  
+  The minitest test class (which inherits from Test::Unit or Minitest::Test) should be removed from the output, as the
+  quickdraw test class is anonymous and implicit.
+  eg 
+  ```ruby
+  class MyTest < Minitest::Test
+    def test_something
+      assert true
+    end
+  end
+  ```
+  becomes
+  ```ruby
+  test "something" do
+      assert true
+  end
+  ```
+  
+  `should` in Test::Unit is the same as `describe` in Quickdraw.
+  
+  minitest "assert" and "refute" methods are mapped to quickdraw `assert` and `refute` methods.
+  
+  minitest "expect" methods are mapped to quickdraw `expect` methods.
+  
+  below are the mappings of minitest methods to quickdraw methods:
+
+  `_(x).must_be`, `expect(x).must_be :==, 0` or `assert_operator x, :==, 0` becomes `expect(x) == 0`
+  `_(x).must_be`, `expect(x).must_be :>, 0` or `assert_operator x, :>, 0`  becomes `assert(x > 0)`
+  `_(x).must_be`, `expect(x).must_be :empty?` `expect(x).must_be_empty` `assert_empty` becomes `assert(x.empty?)`
+  `_(x).must_equal`, `expect(x).must_equal b` or `assert_equal b, x` becomes `expect(x) == b`
+  `_(x).must_be_close_to`, `expect(x).must_be_close_to 2.99999`, `assert_in_epsilon` or `assert_in_delta` becomes `raise "Not implemented in Quickdraw yet"`
+  `_(x).must_be_same_as`, `expect(x).must_be_same_as b`  and `assert_same` becomes `expect(x).to_equal(b)` 
+  `_(x).must_include`, `expect(x).must_include needle`, `assert_includes x, needle` becomes `expect(x).to_include(needle)`  
+  `_(x).must_be_kind_of`, `expect(x).must_be_kind_of Enumerable` or `assert_kind_of Enumerable, x` becomes `assert(x.kind_of? Enumerable)` 
+  `_(x).must_be_instance_of`, `expect(x).must_be_instance_of Array` or `assert_instance_of Array, x` becomes `assert(x.instance_of? Array)` 
+  `_(x).must_be_nil`, `expect(x).must_be_nil` or `assert_nil` becomes `assert(x == nil)` 
+  `_(x).must_match`, `expect(x).must_match /regex/` , `assert_match x, /regex/` becomes `assert(/regex/ === x)`
+  `_(x).must_respond_to`, `expect(x).must_respond_to msg` or `assert_respond_to x, msg` becomes `expect(x).to_respond_to(msg)` 
+  `_(x).wont_respond_to`, `expect(x).wont_respond_to msg` or `refute_respond_to x, msg` becomes `expect(x).not_to_respond_to(msg)` 
+  `proc { "no stdout or stderr" }.must_output` or `assert_output {}`, proc { "no stdout or stderr" }.must_be_silent` or `assert_silent {}`  becomes `raise "Not implemented in Quickdraw yet"` 
+  `proc { ... }.must_raise exception`  or `assert_raises(exp) {}` becomes `expect {}.to_raise(exp)`
+  `proc { ... }.must_throw sym` or `assert_throws(sym) {}`   becomes `raise "Not implemented in Quickdraw yet"`
+
+  note: there are also `refute_*` methods in minitest, which are mapped to either a `refute(...)` or a #not_to* methods in quickdraw.
+
+  Converting `MiniTest::Spec` to `Quickdraw` as follows (like converting from Spec syntax to Test syntax):
+  
+  `subject {}` becomes
+  ```ruby
+  def subject
+    @subject ||= Thing.new
+  end
+  ```
+  
+  `let(:x) { 1 }` becomes
+  ```ruby
+  def x
+      @x ||= 1
+  end
+  ```
+
+  If any modules are included in the minitest class, then take the contents of the module and add it to the output but remove the wrapping `module`
+  Also remove the `include Module` statement from the output.
+  Also remove the def self.included(base) method from the output.
+  
+  Only show me the test file code. Do NOT provide any other description of your work. Always enclose the output code in triple backticks (```).
+
+  The minitest test to convert is as follows:

data/examples/ex1_convert_a_rspec_test_to_minitest.yml

@@ -2,6 +2,7 @@ refactor: rails/minitest/rspec_to_minitest
 input_file_paths:
   - examples/ex1_input_spec.rb
 # We need to add context here as otherwise to tell the AI to require our local test_helper.rb file so that we can run the tests after
-context_text: "In the output test use `require_relative` to include 'test_helper'."
+context_text: "In the output test use `require_relative '../test_helper'` to include 'test_helper'."
 # By default, ai_refactor runs "bundle exec rails test" but this isn't going to work here as we are not actually in a Rails app context in the examples
 minitest_run_command: ruby __FILE__
+output_file_path: examples/outputs/ex1_input_test.rb

data/examples/ex2_input.rb

@@ -0,0 +1,17 @@
+# example from https://blog.kiprosh.com/type-checking-in-ruby-3-using-rbs/
+# basic_math.rb
+
+class BasicMath
+  def initialize(num1, num2)
+    @num1 = num1
+    @num2 = num2
+  end
+
+  def first_less_than_second?
+    @num1 < @num2
+  end
+
+  def add
+    @num1 + @num2
+  end
+end

data/examples/ex2_write_rbs.yml

@@ -0,0 +1,7 @@
+refactor: ruby/write_rbs
+input_file_paths:
+  - examples/ex2_input.rb
+# We need to add context here as our class doesnt actually give any context.
+context_text: "Assume that the inputs can be any numeric type."
+# By default this refactor writes to `sig/...` but here we just put the result in `examples/...`
+output_file_path: examples/outputs/ex2_input.rbs

data/exe/ai_refactor

@@ -6,10 +6,9 @@ require "openai"
 require "shellwords"
 require_relative "../lib/ai_refactor"
 
-require "dotenv/load"
-
-supported_refactors = AIRefactor::Refactors.all
-refactors_descriptions = AIRefactor::Refactors.descriptions
+supported_refactors = AIRefactor::Refactors.all.merge(AIRefactor::Commands.all)
+supported_refactors_names = supported_refactors.keys
+refactors_descriptions = AIRefactor::Refactors.descriptions.merge(AIRefactor::Commands.descriptions)
 
 arguments = ARGV.dup
 
@@ -54,7 +53,7 @@ option_parser = OptionParser.new do |parser|
     run_config.ai_max_attempts = c
   end
 
-  parser.on("-m", "--model MODEL_NAME", String, "Specify a ChatGPT model to use (default gpt-4).") do |m|
+  parser.on("-m", "--model MODEL_NAME", String, "Specify a ChatGPT model to use (default gpt-4-turbo-preview).") do |m|
     run_config.ai_model = m
   end
 
@@ -139,10 +138,9 @@ if arguments.empty? || arguments.all? { |arg| arg.start_with?("-") && !(arg == "
   # For each option that is required but not provided, prompt for it
   # Put the option in arguments to parse with option_parser
   interactive_log.info "Interactive mode started. You can use tab to autocomplete:"
-  predefined_commands = AIRefactor::Refactors.names
 
-  interactive_log.info "Available refactors: #{predefined_commands.join(", ")}\n"
-  command = AIRefactor::Cli.request_input_with_autocomplete("Enter refactor name: ", predefined_commands)
+  interactive_log.info "Available refactors: #{supported_refactors_names.join(", ")}\n"
+  command = AIRefactor::Cli.request_input_with_autocomplete("Enter refactor name: ", supported_refactors_names)
   exit_with_option_error("No refactor name provided.", option_parser) if command.nil? || command.empty?
   initial = [command]
 
@@ -182,10 +180,12 @@ logger = AIRefactor::Logger.new(verbose: run_config.verbose, debug: run_config.d
 logger.info "Also loaded options from '.ai_refactor' file..." if options_from_config_file&.size&.positive?
 
 command_or_file = arguments.shift
-if AIRefactor::CommandFileParser.command_file?(command_or_file)
-  logger.info "Loading refactor command file '#{command_or_file}'..."
+is_built_in_command = AIRefactor::Commands.supported?(command_or_file)
+if is_built_in_command || AIRefactor::CommandFileParser.command_file?(command_or_file)
+  logger.info "Loading #{is_built_in_command ? "built-in" : "custom"} refactor command file '#{command_or_file}'..."
   begin
-    run_config.set!(AIRefactor::CommandFileParser.new(command_or_file).parse)
+    command_file_path = is_built_in_command ? Commands.get(command_name).path : command_or_file
+    run_config.set!(AIRefactor::CommandFileParser.new(command_file_path).parse)
   rescue => e
     exit_with_option_error(e.message, option_parser, logger)
   end

data/lib/ai_refactor/cli.rb

@@ -85,6 +85,9 @@ module AIRefactor
 
         logger.info "AI Refactor #{expanded_inputs.size} files(s)/dir(s) '#{expanded_inputs}' with #{refactorer.refactor_name} refactor\n"
         logger.info "====================\n"
+        if configuration.description
+          logger.info "Description: #{configuration.description}\n"
+        end
 
         return_values = expanded_inputs.map do |file|
           logger.info "Processing #{file}..."

data/lib/ai_refactor/commands.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module AIRefactor
+  module Commands
+    # TODO: support command_line_options
+    BuiltInCommand = Data.define(:name, :description, :path, :command_line_options, :config)
+
+    def get(name)
+      all[name]
+    end
+    module_function :get
+
+    def names
+      all.keys
+    end
+    module_function :names
+
+    def descriptions
+      names.map { |n| "\"#{n}\"" }.zip(all.values.map(&:description)).to_h
+    end
+    module_function :descriptions
+
+    def supported?(name)
+      names.include?(name)
+    end
+    module_function :supported?
+
+    def all
+      @all ||= begin
+        commands = Dir.glob(File.join(__dir__, "../../commands", "**/*.yml")).map do |path|
+          path_to_commands = File.join(__dir__, "../../commands/")
+          name = File.join(File.dirname(path.gsub(path_to_commands, "")), File.basename(path, ".yml")).to_sym
+          config = YAML.safe_load_file(path, permitted_classes: [Symbol], symbolize_names: true, aliases: true)
+          BuiltInCommand.new(name: name, path: path, description: config[:description], config: config, command_line_options: [])
+        end
+        commands.map { |c| [c.name, c] }.to_h
+      end
+    end
+    module_function :all
+  end
+end

data/lib/ai_refactor/file_processor.rb

@@ -62,7 +62,7 @@ module AIRefactor
 
       response = @ai_client.chat(
         parameters: {
-          model: options[:ai_model] || "gpt-4",
+          model: options[:ai_model] || "gpt-4-turbo-preview",
           messages: messages,
           temperature: options[:ai_temperature] || 0.7,
           max_tokens: options[:ai_max_tokens] || 1500

data/lib/ai_refactor/prompt.rb

@@ -70,7 +70,7 @@ module AIRefactor
 
     def input_to_process
       return File.read(@input_file_path) if @input_file_path
-      @input_content
+      @input_content || ""
     end
 
     def input_prompt

data/lib/ai_refactor/refactors/base_refactor.rb

@@ -39,7 +39,7 @@ module AIRefactor
 
       def file_processor
         context = ::AIRefactor::Context.new(files: options[:context_file_paths], text: options[:context_text], logger: logger)
-        prompt = ::AIRefactor::Prompt.new(input_content: input_content, input_path: input_file, output_file_path: output_file_path, prompt: prompt_input, context: context, logger: logger, options: options)
+        prompt = ::AIRefactor::Prompt.new(input_content: input_content, input_path: input_file, output_file_path: output_file_path, prompt: prompt_input, context: context, logger: logger, prompt_footer: prompt_footer, options: options)
         AIRefactor::FileProcessor.new(prompt: prompt, ai_client: ai_client, output_path: output_file_path, logger: logger, options: options)
       end
 
@@ -102,22 +102,46 @@ module AIRefactor
         false
       end
 
-      def prompt_input
-        if options && options[:prompt]&.length&.positive?
-          return options[:prompt]
-        end
+      def prompt_template_for_refactor
+        location = Module.const_source_location(::AIRefactor::Refactors::BaseRefactor.name)
+        File.join(File.dirname(location.first), "#{refactor_name}.md")
+      end
+
+      def prompt_template_for_refactor?
+        File.exist?(prompt_template_for_refactor)
+      end
+
+      def user_provided_prompt_template?
+        options[:prompt_file_path]&.length&.positive?
+      end
 
-        file = if options && options[:prompt_file_path]&.length&.positive?
-          options[:prompt_file_path]
+      def prompt_from_file?
+        user_provided_prompt_template? || prompt_template_for_refactor?
+      end
+
+      def user_provided_prompt?
+        options[:prompt]&.length&.positive?
+      end
+
+      def prompt_input
+        if user_provided_prompt_template?
+          file = options[:prompt_file_path]
+          raise "No prompt file '#{file}' found. Check prompt_file_path is valid" unless File.exist?(file)
+          File.read(file)
         else
-          location = Module.const_source_location(::AIRefactor::Refactors::BaseRefactor.name)
-          File.join(File.dirname(location.first), "#{refactor_name}.md")
-        end
-        file.tap do |prompt|
-          raise "No prompt file '#{prompt}' found for #{refactor_name}" unless File.exist?(prompt)
+          file = prompt_template_for_refactor
+          if File.exist?(file)
+            File.read(file)
+          elsif user_provided_prompt?
+            options[:prompt]
+          else
+            raise "No prompt was provided. Please provide one with the --prompt option or with a command file."
+          end
         end
+      end
 
-        File.read(file)
+      def prompt_footer
+        options[:prompt] if user_provided_prompt? && prompt_from_file?
       end
 
       def output_file_path

data/lib/ai_refactor/refactors/custom.rb

@@ -4,7 +4,7 @@ module AIRefactor
   module Refactors
     class Custom < BaseRefactor
       def run
-        logger.verbose "Custom refactor to #{input_file}... (using user supplied prompt #{prompt_file_path})"
+        logger.verbose "Custom refactor to #{input_file}... (using user supplied prompt #{prompt_file_path || "from options"})"
         logger.verbose "Write output to #{output_file_path}..." if output_file_path
 
         begin
@@ -26,6 +26,7 @@ module AIRefactor
       private
 
       def prompt_file_path
+        return if options[:prompt]&.length&.positive?
         specified_prompt_path = options[:prompt_file_path]
         if specified_prompt_path&.length&.positive?
           if File.exist?(specified_prompt_path)

data/lib/ai_refactor/refactors/ruby/refactor_ruby.md

@@ -5,6 +5,4 @@ __{{prompt_header}}__
 The input file is: __{{input_file_path}}__
 The output file path is: __{{output_file_path}}__
 
-__{{content}}__
-
 __{{prompt_footer}}__

data/lib/ai_refactor/refactors/ruby/write_rbs.md

@@ -0,0 +1,118 @@
+You are an expert Ruby senior software developer.
+
+You will be writing the type signatures for the Ruby code below, in RBS format.
+
+RBS is a language to describe the structure of Ruby programs. You can write down the definition of a class or module: methods defined in the class, instance variables and their types, and inheritance/mix-in relations. It also allows declaring constants and global variables.
+
+The following is a small example of RBS for a chat app.
+
+Given the Ruby
+```ruby
+module ChatApp
+  VERSION = "1.0.0"
+  class User
+    attr_reader :login, :email
+    
+    def initialize(login:, email:); end
+      
+    def my_method(String arg1, Integer arg2); end
+  end
+  
+  class Bot
+    attr_reader :name
+    attr_reader :email
+    attr_reader :owner
+
+    def initialize(name:, owner:); end
+  end
+
+  class Message
+    attr_reader :id, :string, :from, :reply_to
+
+    def initialize(from:, string:); end
+
+    def reply(from:, string:)
+      Message.new(from, string)
+    end
+  end
+
+  class Channel
+    attr_reader :name, :messages, :users, :bots
+
+    def initialize(name)
+      @name = name
+      @messages = []
+      @users = []
+      @bots = []
+    end
+
+    def each_member(&block)
+      members = users + bots
+      block? ? members.each(&block) : members.each
+    end
+  end
+end
+```
+
+We can write the RBS as follows:
+```
+module ChatApp
+  VERSION: String
+
+  class User
+    attr_reader login: String
+    attr_reader email: String
+
+    # If a method takes keyword arguments then use `key: Type` syntax.
+    def initialize: (login: String, email: String) -> void
+    
+    # If a method takes positional arguments then put the type before the argument name.
+    def my_method: (String arg1, Integer arg2) -> String
+  end
+
+  class Bot
+    attr_reader name: String
+    attr_reader email: String
+    attr_reader owner: User
+
+    def initialize: (name: String, owner: User) -> void
+  end
+
+  class Message
+    attr_reader id: String
+    attr_reader string: String
+    attr_reader from: User | Bot                     # `|` means union types: `#from` can be `User` or `Bot`
+    attr_reader reply_to: Message?                   # `?` means optional type: `#reply_to` can be `nil`
+
+    def initialize: (from: User | Bot, string: String) -> void
+
+    def reply: (from: User | Bot, string: String) -> Message
+  end
+
+  class Channel
+    attr_reader name: String
+    attr_reader messages: Array[Message]
+    attr_reader users: Array[User]
+    attr_reader bots: Array[Bot]
+
+    def initialize: (String name) -> void
+
+    def each_member: () { (User | Bot) -> void } -> void  # `{` and `}` means block.
+                   | () -> Enumerator[User | Bot, void]   # Method can be overloaded.
+  end
+end
+```
+
+Note, when writing the RBS for a class method, eg one in a `class << self` block, use `def self.method` in the
+type definition.
+
+Do not include comments in your RBS code or start the file with 'rbs' or '.rbs'.
+
+__{{context}}__
+
+__{{prompt_header}}__
+
+The input file is: __{{input_file_path}}__
+The output file path is: __{{output_file_path}}__
+
+__{{prompt_footer}}__

data/lib/ai_refactor/refactors/ruby/write_rbs.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AIRefactor
+  module Refactors
+    module Ruby
+      class WriteRbs < BaseRefactor
+        def run
+          logger.verbose "Write some RBS for #{input_file}..."
+          logger.verbose "Write output to #{output_file_path}..." if output_file_path
+
+          begin
+            output_content = process!(strip_ticks: true)
+          rescue => e
+            logger.error "Failed to process #{input_file}: #{e.message}"
+            return false
+          end
+
+          return false unless output_content
+
+          if output_file_path
+            steep_runner = AIRefactor::TestRunners::SteepRunner.new(input_file, command_template: options.minitest_run_command)
+
+            logger.verbose "Run steep against generated RBS file #{output_file_path} (`#{steep_runner.command}`)..."
+            test_run = steep_runner.run
+
+            if test_run.failed?
+              logger.warn "#{input_file} was translated to #{output_file_path} but the resulting RBS fails to pass a steep check..."
+              logger.error "Failed to run test, exited with status #{test_run.exitstatus}. Stdout: #{test_run.stdout}\n\nStderr: #{test_run.stderr}\n\n"
+              logger.error "New RBS failed!", bold: true
+              self.failed_message = "Generated RBS file failed to pass checks"
+              return false
+            end
+
+            logger.verbose "\nNew RBS file passed checks"
+          end
+
+          output_file_path ? true : output_content
+        end
+
+        def self.description
+          "User supplied prompt to write RBS for some Ruby"
+        end
+
+        def default_output_path
+          File.join("sig", input_file.gsub(/\.rb$/, ".rbs"))
+        end
+      end
+    end
+  end
+end

data/lib/ai_refactor/refactors/ruby/write_ruby.md

@@ -2,6 +2,4 @@ __{{context}}__
 
 __{{prompt_header}}__
 
-__{{content}}__
-
 __{{prompt_footer}}__

data/lib/ai_refactor/run_configuration.rb

@@ -8,10 +8,12 @@ module AIRefactor
     end
 
     attr_reader :refactor,
+      :description,
       :input_file_paths,
       :output_file_path,
       :output_template_path,
       :context_file_paths,
+      :context_file_paths_from_gems,
       :context_text,
       :review_prompt,
       :prompt,
@@ -33,7 +35,7 @@ module AIRefactor
       end
     end
 
-    attr_writer :refactor
+    attr_writer :refactor, :description
 
     # @deprecated
     def [](key)
@@ -56,6 +58,25 @@ module AIRefactor
       @context_file_paths.concat(paths)
     end
 
+    # A hash is passed in, where the keys are gem names that should be in the bundle and the path is a path inside the gem
+    # install location. We resolve the absolute path of each and then add to @context_file_paths
+    def context_file_paths_from_gems=(paths)
+      @context_file_paths ||= []
+      @context_file_paths_from_gems ||= {}
+      @context_file_paths_from_gems.merge!(paths)
+
+      paths.each do |gem_name, paths|
+        paths = [paths] unless paths.is_a?(Array)
+        paths.each do |path|
+          gem_spec = Gem::Specification.find_by_name(gem_name.to_s)
+          raise "Gem #{gem_name} not found" unless gem_spec
+          gem_path = gem_spec.gem_dir
+          full_path = File.join(gem_path, path)
+          @context_file_paths << full_path
+        end
+      end
+    end
+
     def context_text=(text)
       @context_text ||= ""
       @context_text += text
@@ -81,7 +102,7 @@ module AIRefactor
     end
 
     def ai_model=(value)
-      @ai_model = value || "gpt-4"
+      @ai_model = value || "gpt-4-turbo-preview"
     end
 
     def ai_temperature=(value)

data/lib/ai_refactor/test_runners/steep_runner.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module AIRefactor
+  module TestRunners
+    class SteepRunner
+      def initialize(file_path, command_template: "bundle exec steep __FILE__")
+        @file_path = file_path
+        @command_template = command_template
+      end
+
+      def command
+        @command_template.gsub("__FILE__", @file_path)
+      end
+
+      def run
+        stdout, stderr, status = Open3.capture3(command)
+        # TODO: parse output
+        # look initally for Cannot find a configuration at Steepfile
+        #
+        # _matched, runs, _assertions, failures, errors, skips = stdout.match(/(\d+) runs, (\d+) assertions, (\d+) failures, (\d+) errors, (\d+) skips/).to_a
+        TestRunResult.new(stdout, stderr, status) # , runs, failures, skips, errors)
+      end
+    end
+  end
+end

data/lib/ai_refactor/test_runners/test_run_result.rb

@@ -5,7 +5,7 @@ module AIRefactor
     class TestRunResult
       attr_reader :stdout, :stderr, :example_count, :failure_count, :pending_count
 
-      def initialize(stdout, stderr, status, example_count, failure_count, pending_count, errored)
+      def initialize(stdout, stderr, status, example_count = 0, failure_count = 0, pending_count = 0, errored = 0)
         @stdout = stdout
         @stderr = stderr
         @status = status

data/lib/ai_refactor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_refactor
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -47,7 +47,7 @@ dependencies:
         version: 3.4.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -57,7 +57,7 @@ dependencies:
         version: 3.4.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -84,20 +84,23 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - ai_refactor.gemspec
-- examples/.gitignore
+- commands/quickdraw/0.1.0/convert_minitest.yml
 - examples/ex1_convert_a_rspec_test_to_minitest.yml
 - examples/ex1_input_spec.rb
+- examples/ex2_input.rb
+- examples/ex2_write_rbs.yml
 - examples/rails_helper.rb
 - examples/test_helper.rb
 - exe/ai_refactor
 - lib/ai_refactor.rb
 - lib/ai_refactor/cli.rb
 - lib/ai_refactor/command_file_parser.rb
+- lib/ai_refactor/commands.rb
 - lib/ai_refactor/context.rb
 - lib/ai_refactor/file_processor.rb
 - lib/ai_refactor/logger.rb
@@ -117,12 +120,15 @@ files:
 - 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_rbs.md
+- lib/ai_refactor/refactors/ruby/write_rbs.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/templated_path.rb
 - lib/ai_refactor/test_runners/minitest_runner.rb
 - lib/ai_refactor/test_runners/rspec_runner.rb
+- lib/ai_refactor/test_runners/steep_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
@@ -147,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Use AI to convert a Rails RSpec test suite to minitest.

data/Gemfile.lock

@@ -1,244 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ai_refactor (0.5.2)
-      colorize (< 2.0)
-      open3 (< 2.0)
-      ruby-openai (>= 3.4.0, < 5.0)
-      zeitwerk (~> 2.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (7.0.8)
-      actionpack (= 7.0.8)
-      activesupport (= 7.0.8)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.8)
-      actionpack (= 7.0.8)
-      activejob (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.0.8)
-      actionpack (= 7.0.8)
-      actionview (= 7.0.8)
-      activejob (= 7.0.8)
-      activesupport (= 7.0.8)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
-      rails-dom-testing (~> 2.0)
-    actionpack (7.0.8)
-      actionview (= 7.0.8)
-      activesupport (= 7.0.8)
-      rack (~> 2.0, >= 2.2.4)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.8)
-      actionpack (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      globalid (>= 0.6.0)
-      nokogiri (>= 1.8.5)
-    actionview (7.0.8)
-      activesupport (= 7.0.8)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.8)
-      activesupport (= 7.0.8)
-      globalid (>= 0.3.6)
-    activemodel (7.0.8)
-      activesupport (= 7.0.8)
-    activerecord (7.0.8)
-      activemodel (= 7.0.8)
-      activesupport (= 7.0.8)
-    activestorage (7.0.8)
-      actionpack (= 7.0.8)
-      activejob (= 7.0.8)
-      activerecord (= 7.0.8)
-      activesupport (= 7.0.8)
-      marcel (~> 1.0)
-      mini_mime (>= 1.1.0)
-    activesupport (7.0.8)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    builder (3.2.4)
-    colorize (0.8.1)
-    concurrent-ruby (1.2.2)
-    crass (1.0.6)
-    date (3.3.3)
-    diff-lcs (1.5.0)
-    dotenv (2.8.1)
-    erubi (1.12.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (3.0.2)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.0.0)
-    loofah (2.21.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    mail (2.8.1)
-      mini_mime (>= 0.1.1)
-      net-imap
-      net-pop
-      net-smtp
-    marcel (1.0.2)
-    method_source (1.0.0)
-    mini_mime (1.1.5)
-    minitest (5.18.0)
-    multipart-post (2.3.0)
-    net-imap (0.3.7)
-      date
-      net-protocol
-    net-pop (0.1.2)
-      net-protocol
-    net-protocol (0.2.1)
-      timeout
-    net-smtp (0.3.3)
-      net-protocol
-    nio4r (2.5.9)
-    nokogiri (1.15.4-arm64-darwin)
-      racc (~> 1.4)
-    open3 (0.1.2)
-    parallel (1.23.0)
-    parser (3.2.2.1)
-      ast (~> 2.4.1)
-    racc (1.7.1)
-    rack (2.2.8)
-    rack-test (2.1.0)
-      rack (>= 1.3)
-    rails (7.0.8)
-      actioncable (= 7.0.8)
-      actionmailbox (= 7.0.8)
-      actionmailer (= 7.0.8)
-      actionpack (= 7.0.8)
-      actiontext (= 7.0.8)
-      actionview (= 7.0.8)
-      activejob (= 7.0.8)
-      activemodel (= 7.0.8)
-      activerecord (= 7.0.8)
-      activestorage (= 7.0.8)
-      activesupport (= 7.0.8)
-      bundler (>= 1.15.0)
-      railties (= 7.0.8)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.0)
-      loofah (~> 2.21)
-      nokogiri (~> 1.14)
-    railties (7.0.8)
-      actionpack (= 7.0.8)
-      activesupport (= 7.0.8)
-      method_source
-      rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-rails (6.0.3)
-      actionpack (>= 6.1)
-      activesupport (>= 6.1)
-      railties (>= 6.1)
-      rspec-core (~> 3.12)
-      rspec-expectations (~> 3.12)
-      rspec-mocks (~> 3.12)
-      rspec-support (~> 3.12)
-    rspec-support (3.12.1)
-    rubocop (1.50.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.16.0)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-openai (4.1.0)
-      faraday (>= 1)
-      faraday-multipart (>= 1)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    shoulda-matchers (5.3.0)
-      activesupport (>= 5.2.0)
-    standard (1.28.2)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50.2)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.0.1)
-    standard-custom (1.0.0)
-      lint_roller (~> 1.0)
-    standard-performance (1.0.1)
-      lint_roller (~> 1.0)
-      rubocop-performance (~> 1.16.0)
-    thor (1.2.2)
-    timeout (0.4.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
-    websocket-driver (0.7.6)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.6.8)
-
-PLATFORMS
-  arm64-darwin-22
-
-DEPENDENCIES
-  ai_refactor!
-  dotenv
-  minitest (~> 5.0)
-  rails
-  rake (~> 13.0)
-  rspec
-  rspec-rails
-  shoulda-matchers
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.4.10

data/examples/.gitignore

@@ -1 +0,0 @@
-ex1_input_test.rb