ai_refactor 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725fb1da5fc311d3740687d97fa3b6c3c4292a3b531f467ea1d8ff9e734608bc
-  data.tar.gz: 4c16d310c643ae1158442816a9f863961ae151bb4ae486c965e96340342e2d44
+  metadata.gz: e50d610e50fdbccc133cd5951cee61244602b402917aa2eb1ab37713b3a6b276
+  data.tar.gz: eee461b016a3dec20476828383da3571999649097472eedc68f736d6ea759057
 SHA512:
-  metadata.gz: d0f380ef54a29be017b23c2caaa4491ee6304dc410e52ab6e11038b9f30c30a09a04597f3342332f464007e0e932f5b81112f712d46c584b2728d51bee61c036
-  data.tar.gz: 9ffa29857815cb73daef7d6902bf7301dc80e36361b0451d3d3df1b7921b1c0978ef16ea7963c544b893db1bd0d6db34120378aa6a7ae4ac5add0831e4b61dbf
+  metadata.gz: c4c913a3263949687e98681697e5fe2631748aa57dbc3ea4c7aa3f367a3ce98cb6d2d3ea86653f2e949fd65d055dd9c0f67d93c79602742fb179a27568639ed6
+  data.tar.gz: 41324b5dd54d62f59d749638c7b813e4d2fcc4d75528aaf4e37ba4027773b87195a1dad6ffc4400b9ce34ba38004319d7385879b8d01f00a8161a86eec842a6a

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # AI Refactor Changelog
 
+## [0.5.1] - 2023-09-21
+
+### Added
+
+- Support for substitutions in path templates.
+
+### Fixed
+
+- Fixes issue with refactor type specified on command line not being picked up.
+
+
+## [0.5.0] - 2023-09-21
+
+### Added
+
+- Support for new command files, which are YAML files that can be used to define options for a refactor. This makes it
+  simpler to create configurations for refactors that will be used repeatedly. They can be committed to source control
+  of your project and shared with other developers.
+- Support for configuring the run commands for the test runners
+- Adding real life examples
+
 ## [0.4.0] - 2023-08-15
 
 ### Added

data/Gemfile

@@ -12,3 +12,10 @@ gem "minitest", "~> 5.0"
 gem "standard", "~> 1.3"
 
 gem "dotenv"
+
+# for the examples
+
+gem "rails"
+gem "rspec"
+gem "rspec-rails"
+gem "shoulda-matchers"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ai_refactor (0.4.0)
+    ai_refactor (0.5.1)
       colorize (< 2.0)
       open3 (< 2.0)
       ruby-openai (>= 3.4.0, < 5.0)
@@ -10,28 +10,179 @@ PATH
 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)
@@ -52,6 +203,8 @@ GEM
       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)
@@ -63,7 +216,14 @@ GEM
     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
@@ -73,7 +233,11 @@ DEPENDENCIES
   ai_refactor!
   dotenv
   minitest (~> 5.0)
+  rails
   rake (~> 13.0)
+  rspec
+  rspec-rails
+  shoulda-matchers
   standard (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -1,22 +1,75 @@
-# AI Refactor for Ruby
+# AIRefactor for Ruby
 
-AI Refactor is an experimental tool to use AI to help apply refactoring to code.
+__The goal for AIRefactor is to use LLMs to apply repetitive refactoring tasks to code.__
 
-__The goal for AI Refactor is to help apply repetitive refactoring tasks, not to replace human mind that decides what refactoring is needed.__
+First the human decides what refactoring is needed and builds up a prompt to describe the task, or uses one of AIRefactors provided prompts.
+
+AIRefactor then helps to apply the refactoring to one or more files.
+
+In some cases, the tool can then check the generated code by running tests and comparing test outputs.
+
+#### Notes
+
+AI Refactor is an experimental tool and under active development as I explore the idea myself. It may not work as expected, or
+change in ways that break existing functionality.
+
+The focus of the tool is work with the Ruby programming language ecosystem, but it can be used with any language.
 
 AI Refactor currently uses [OpenAI's ChatGPT](https://platform.openai.com/).
 
-The tool lets the human user prompt the AI with explicit refactoring tasks, and can be run on one or more files at a time. 
-The tool then uses a LLM to apply the relevant refactor, and if appropriate, checks results by running tests and comparing output.
+## Examples
+
+See the [examples](examples/) directory for some examples of using the tool.
+
+You can run the command files to run the example.
+
+For example, the first example can be run with: (you can add options if desired, eg `-v` for verbose output and `-d` for debug output)
+
+```shell
+./exe/ai_refactor examples/ex1_convert_a_rspec_test_to_minitest.yml
+```
+
+You should see:
+    
+```
+$ ./exe/ai_refactor examples/ex1_convert_a_rspec_test_to_minitest.yml
+Loading refactor command file 'examples/ex1_convert_a_rspec_test_to_minitest.yml'...
+AI Refactor 1 files(s)/dir(s) '["examples/ex1_input_spec.rb"]' with rails/minitest/rspec_to_minitest refactor
+====================
+Processing examples/ex1_input_spec.rb...
+
+No differences found! Conversion worked!
+Refactor succeeded on examples/ex1_input_spec.rb
+
+All files processed successfully!
+Done processing all files!
+```
+
+And find the file `examples/ex1_input_test.rb` has been created. Note the process above also ran the generated test file and compared the output to the original test file.
+
+If you see an error, then try to run it again, or use a different GPT model.
 
-The focus of the tool is work with the Ruby programming language ecosystem, but it can be used with any language. 
 
 ## Available refactors
 
-Currently available:
+Write your own prompt:
+
+- `ruby/write_ruby`: provide your own prompt for the AI and expect to output Ruby code (no input files required)
+- `ruby/refactor_ruby`: provide your own refactoring prompt for the AI and expect to output Ruby code
+- `custom`: provide your own prompt for the AI and run against the input files. There is no expectation of the output.
 
+Use a pre-built prompt:
+
+- `minitest/write_test_for_class`: write a minitest test for a given class
 - `rails/minitest/rspec_to_minitest`: convert RSpec specs to minitest tests in Rails apps
-- `generic`: provide your own prompt for the AI and run against the input files
+
+### User supplied prompts, eg `custom`, `ruby/write_ruby` and `ruby/refactor_ruby`
+
+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`, or to a file with the `--output` option.
+
+User supplied prompts are best configured using a command file, see below.
 
 ### `rails/minitest/rspec_to_minitest`
 
@@ -44,12 +97,6 @@ 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`, or to a file with the `--output` option. 
-
 ### `minitest/write_test_for_class`
 
 Writes a minitest test for a given class. The output will, by default, be put into a directory named `test` in the current directory,
@@ -75,13 +122,14 @@ If bundler is not being used to manage dependencies, install the gem by executin
 See `ai_refactor --help` for more information.
 
 ```
-Usage: ai_refactor REFACTOR_TYPE INPUT_FILE_OR_DIR [options]
+Usage: ai_refactor REFACTOR_TYPE_OR_COMMAND_FILE INPUT_FILE_OR_DIR [options]
 
-Where REFACTOR_TYPE is one of: ["generic" ... (run ai_refactor --help for full list of refactor types)]
+Where REFACTOR_TYPE_OR_COMMAND_FILE is either the path to a command YML file, or one of the refactor types: ["custom" ... (run ai_refactor --help for full list of refactor types)]
 
     -o, --output [FILE]              Write output to given file instead of stdout. If no path provided will overwrite input file (will prompt to overwrite existing files). Some refactor tasks will write out to a new file by default. This option will override the tasks default behaviour.
     -O, --output-template TEMPLATE   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)
     -c, --context CONTEXT_FILES      Specify one or more files to use as context for the AI. The contents of these files will be prepended to the prompt sent to the AI.
+    -x, --extra CONTEXT_TEXT         Specify some text to be prepended to the prompt sent to the AI as extra information of note.
     -r, --review-prompt              Show the prompt that will be sent to ChatGPT but do not actually call ChatGPT or make changes to files.
     -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.
@@ -91,11 +139,81 @@ Where REFACTOR_TYPE is one of: ["generic" ... (run ai_refactor --help for full l
         --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.
         --overwrite ANSWER           Always overwrite existing output files, 'y' for yes, 'n' for no, or 'a' for ask. Default to ask.
+    -N, --no                         Never overwrite existing output files, same as --overwrite=n.
     -v, --verbose                    Show extra output and progress info
     -d, --debug                      Show debugging output to help diagnose issues
     -h, --help                       Prints this help
 ```
 
+### Interactive mode
+
+A basic interactive mode exists too, where you are prompted for options. 
+
+Start interactive mode by not specifying anything for `REFACTOR_TYPE_OR_COMMAND_FILE` (ie no refactor type or command file)
+
+### Command files and Custom prompts
+
+Apart from invoking the tool with CLI options, the tool can also be invoked with a command file.
+
+This makes it easier to build custom refactor prompts for projects, and run that custom refactor multiple times.
+
+The command file is a YAML file that contains configuration options to pass to the tool.
+
+The format of the YAML file is:
+
+```yaml
+# Required options:
+refactor: refactor type name, eg 'ruby/write_ruby'
+# Optional options:
+input_file_paths: 
+  - input files or directories
+output_file_path: output file or directory
+output_template_path: output file template (see docs)
+prompt_file_path: path
+prompt: |
+  A custom prompt to send to ChatGPT if the command needs it (otherwise read from file)
+context_file_paths: 
+    - file1.rb
+    - file2.rb
+# Other configuration options:
+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_temperature: ChatGPT temperature (default 0.7)
+ai_max_tokens: ChatGPT max tokens (default 1500)
+ai_timeout: ChatGPT timeout (default 60)
+overwrite: y/n/a (default a)
+verbose: true/false (default false)
+debug: true/false (default false)
+```
+
+The command file can be invoked by passing it as the first argument to the tool:
+
+```shell
+ai_refactor my_command_file.yml
+```
+
+Other options can be passed on the command line and will override the options in the command file.
+
+For example, if the command file contains:
+
+```shell
+ai_refactor my_command_file.yml my_input.rb -d --output foo.rb
+```
+
+### Prompt template substitutions
+
+Prompt text can contain the following substitutions:
+
+* `__{{input_file_path}}__`: the path to the input file
+* `__{{output_file_path}}__`: the path to the output file
+* `__{{prompt_header}}__`: the place the pre-build prompt will be injected, if used
+* `__{{prompt_footer}}__`: prompt text that will be inserted after the prompt, eg the "make diffs" prompt if `--diffs` is used
+* `__{{context}}__`: the contents of the context files, if any
+* `__{{content}}__`: the contents of input file, if any
+
 ## Outputs
 
 Some refactor tasks will write out to a new file by default, others to stdout.
@@ -117,6 +235,17 @@ eg for the input `my_dir/my_class.rb`
 - `[REFACTOR]`: `generic`
 - `[EXT]`: `.rb`
 
+## Configuration
+
+### `.ai_refactor` file
+
+The tool can be configured using a `.ai_refactor` file in the current directory or in the user's home directory.
+
+This file provides default CLI switches to add to any `ai_refactor` command.
+
+## Command history
+
+The tool keeps a history of commands run in the `.ai_refactor_history` file in the current working directory.
 
 ## Note on performance and ChatGPT version
 

data/examples/.gitignore

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

data/examples/ex1_convert_a_rspec_test_to_minitest.yml

@@ -0,0 +1,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'."
+# 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__

data/examples/ex1_input_spec.rb

@@ -0,0 +1,32 @@
+require_relative "rails_helper"
+
+RSpec.describe MyModel, type: :model do
+  subject(:model) { described_class.new }
+
+  it { is_expected.to validate_presence_of(:name) }
+
+  it "should allow integer values for age" do
+    model.age = 1
+    expect(model.age).to eq 1
+  end
+
+  it "should allow string values for name" do
+    model.name = "test"
+    expect(model.name).to eq "test"
+  end
+
+  it "should be invalid with invalid name" do
+    model.name = nil
+    expect(model).to be_invalid
+  end
+
+  it "should convert integer values for name" do
+    model.name = 1
+    expect(model.name).to eq "1"
+  end
+
+  it "should not allow string values for age" do
+    model.age = "test"
+    expect(model.age).to eq 0
+  end
+end

data/examples/rails_helper.rb

@@ -0,0 +1,21 @@
+require "rails/all"
+require "shoulda-matchers"
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end
+
+class MyModel
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+  include ActiveModel::Validations
+  include ActiveModel::Validations::Callbacks
+
+  validates :name, presence: true
+
+  attribute :name, :string
+  attribute :age, :integer
+end

data/examples/test_helper.rb

@@ -0,0 +1,14 @@
+require "rails/all"
+require "active_support/testing/autorun"
+
+class MyModel
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+  include ActiveModel::Validations
+  include ActiveModel::Validations::Callbacks
+
+  validates :name, presence: true
+
+  attribute :name, :string
+  attribute :age, :integer
+end