ai_refactor 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15f32bc208d6025b339dd08061747f790975c9163909a83dac8d3abc381b4fac
-  data.tar.gz: cb1e71b84e2aa8b77900a5a33f10090f3ee65d6d6f0fba606359c5a2cb1f2719
+  metadata.gz: 9ebe9a5f356fd432e2e0fdba9c96bc78ea6e5d9b8f2b98357f7a75bd1a53be35
+  data.tar.gz: 035fb030362ff96600eee4a57939077ae6b1d2c1c0faf2b6f2ec5cfd5c3b8570
 SHA512:
-  metadata.gz: 9b16ab1f05053cbe504cdda1f66326ec0ee27977e322df37ad5b00ffc319dd7c5692785f564a04ba4a6dc238015689f6ed7aca901ab4dc7bad84f418ad887c0e
-  data.tar.gz: a18db957cfd44fbf817b61c5b198f6bd122d6f8368f098925ff2b4de3f94c88f3f913133685424107e06b6c9338c6b70f1d6e5b0bb98b7865cecbee522b1cdb0
+  metadata.gz: 764bde690ee5d65522a91e11642e830cb60a1704a20811d00ee522b33b358c36ad7a4193bf437373ce735434fad4f824ddf378ad55c83cce205eeac3311da1f5
+  data.tar.gz: a19722433c2ed1778a45779383a51dbeb21d0f421efc9b41510c581c96318f7b04b5914bfbea4ca155155742a573b9d3c6a3e0e75b1d0eed43b25b19d6081c62

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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

data/Gemfile.lock

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

data/README.md

@@ -21,6 +21,35 @@ AI Refactor currently uses [OpenAI's ChatGPT](https://platform.openai.com/).
 
 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.
+
+
 ## Available refactors
 
 Write your own prompt:

data/exe/ai_refactor

@@ -179,7 +179,7 @@ rescue OptionParser::InvalidOption, OptionParser::MissingArgument
 end
 
 logger = AIRefactor::Logger.new(verbose: run_config.verbose, debug: run_config.debug)
-logger.info "Loaded config from '#{options_from_config_file}'..." if options_from_config_file
+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)
@@ -191,6 +191,7 @@ if AIRefactor::CommandFileParser.command_file?(command_or_file)
   end
 else
   logger.info "Requested to run refactor '#{command_or_file}'..."
+  run_config.refactor = command_or_file
 end
 
 run_config.input_file_paths = arguments

data/lib/ai_refactor/cli.rb

@@ -56,7 +56,7 @@ module AIRefactor
     attr_reader :configuration, :logger
 
     def refactoring_type
-      configuration.refactor
+      configuration.refactor || raise(StandardError, "No refactor provided")
     end
 
     def inputs

data/lib/ai_refactor/context.rb

@@ -14,7 +14,7 @@ module AIRefactor
       if @text.nil? || @text.empty?
         file_context
       else
-        "Also note: #{@text}\n\n#{file_context}"
+        "\n#{file_context}\n\n#{@text}\n"
       end
     end
 

data/lib/ai_refactor/refactors/base_refactor.rb

@@ -79,7 +79,6 @@ module AIRefactor
           output_content
         rescue => e
           logger.error "Request to AI failed: #{e.message}"
-          puts e.backtrace
           logger.warn "Skipping #{input_file}..."
           self.failed_message = "Request to OpenAI failed"
           raise e
@@ -147,11 +146,7 @@ module AIRefactor
       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))
+        path = AIRefactor::TemplatedPath.new(input_file, refactor_name, output_template_path).generate
         raise "Output template could not be used" unless path.length.positive?
         path
       end

data/lib/ai_refactor/refactors/minitest/write_test_for_class.md

@@ -6,10 +6,10 @@ The output file path is: __{{output_file_path}}__
 
 __{{prompt_header}}__
 
-Only show me the test file code. Do NOT provide any other description of your work. Always enclose the output code in triple backticks (```).
-
 __{{context}}__
 
+Only show me the test file code. Do NOT provide any other description of your work. Always enclose the output code in triple backticks (```).
+
 __{{prompt_footer}}__
 
 The class to test is:

data/lib/ai_refactor/refactors/minitest/write_test_for_class.rb

@@ -19,9 +19,9 @@ module AIRefactor
 
           logger.verbose "Generated #{output_file_path} from #{input_file} ..." if output_content
 
-          minitest_runner = AIRefactor::TestRunners::MinitestRunner.new(output_file_path, command_template: "bundle exec ruby __FILE__")
+          minitest_runner = AIRefactor::TestRunners::MinitestRunner.new(output_file_path, command_template: options.minitest_run_command)
 
-          logger.verbose "Run generated test file #{output_file_path} (#{minitest_runner.command})..."
+          logger.verbose "Run generated test file #{output_file_path} (`#{minitest_runner.command}`)..."
           test_run = minitest_runner.run
 
           if test_run.failed?

data/lib/ai_refactor/templated_path.rb

@@ -0,0 +1,47 @@
+module AIRefactor
+  class TemplatedPath
+    def initialize(input_file, refactor_name, template)
+      @input_file = input_file
+      @refactor_name = refactor_name
+      raise ArgumentError unless template.length.positive?
+      @template = template
+    end
+
+    def generate
+      path_from_template
+    end
+
+    private
+
+    def path_from_template
+      path = @template.dup
+      @template.scan(/\[(FILE|NAME|DIR|REFACTOR|EXT)(\|([^|]+)\|([^\]]*))?\]/).each do |match|
+        type, sub, old_value, new_value = match
+        value = send(type.downcase.to_sym)
+        value = value.gsub(old_value, new_value) if sub
+        path.gsub!("[#{type}#{sub}]", value)
+      end
+      path
+    end
+
+    def file
+      File.basename(@input_file)
+    end
+
+    def name
+      File.basename(@input_file, ".*")
+    end
+
+    def dir
+      File.dirname(@input_file)
+    end
+
+    def refactor
+      @refactor_name
+    end
+
+    def ext
+      File.extname(@input_file)
+    end
+  end
+end

data/lib/ai_refactor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ai_refactor
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Stephen Ierodiaconou
@@ -120,6 +120,7 @@ files:
 - 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/test_run_diff_report.rb