ai_refactor 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 758af953e626b18190ef1e2252e730ea636d773a53b63052aaa7aba6213b49a2
-  data.tar.gz: 2bf63e217e7c3647e9cc26a9112f72eb19b81700f5784730a15ec0b229889963
+  metadata.gz: aae248c6a2c5342ea8990e2a672b455c48ec79645e8d88eb20f9afc1af9e7cce
+  data.tar.gz: f86584d15b6467600be12797e4f34bf4ce4545ad6be3bbaef8f9ce62817dd66f
 SHA512:
-  metadata.gz: 76e034568b78234e7b66c756601be73976f3367c542112b6cfc88c47ab3edb31016a8507201eee382a33ed2c7d041707295fcf140cfecc859a1d6e5b99c52d35
-  data.tar.gz: bb00b41760079e5203c5bcadbff10c09b7fc701ec12a1c25623dbff85862e6c3de0416d341ad41c22d03dad54fdadc97ccb33e2a02756186a65ad9e4dfb17d4d
+  metadata.gz: a4d1aa38dc497acd25038229da1fe3e46bcbb4dd26cf33770f2bfe1a8a44a48c656023a2b9342a0b81c9fb620ecc4bc28dba215ef2225da8e5e22b13a8d73d92
+  data.tar.gz: e1a7e38d44b83b81da06dcb684e8ce61532fe37818c1e4c41f14451923cd9ad9c3f78092fba5b0fe65e316c1fe75681bf34b81501d2f99694a6ceb85826cede3

data/Gemfile.lock

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

data/README.md

@@ -11,8 +11,9 @@ This is based on the assumption that the LLM AIs are pretty good at identifying
 
 Currently available:
 
-- `generic`
-- `rspec_to_minitest_rails`
+- `rspec_to_minitest_rails`: convert RSpec specs to minitest tests in Rails apps
+- `generic`: provide your own prompt for the AI and run against the input files
+
 
 ### `rspec_to_minitest_rails`
 
@@ -47,7 +48,20 @@ Done processing all files!
 
 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`.
+The output is written to `stdout`, or to a file with the `--output` option. If `--output` is used without a value it overwrites the input.
+
+You can also output to a file using a template, `--output-template` to determine the output file name given a template string:
+
+The template is used to create the output name, where the it can have substitutions, '[FILE]', '[NAME]', '[DIR]', '[REFACTOR]' & '[EXT]'.
+
+Eg `--output-template "[DIR]/[NAME]_[REFACTOR][EXT]"`
+
+eg for the input `my_dir/my_class.rb`
+- `[FILE]`: `my_class.rb`
+- `[NAME]`: `my_class`
+- `[DIR]`: `my_dir`
+- `[REFACTOR]`: `generic`
+- `[EXT]`: `.rb`
 
 ## Installation
 
@@ -66,7 +80,7 @@ See `ai_refactor --help` for more information.
 ```
 Usage: ai_refactor REFACTOR_TYPE INPUT_FILE_OR_DIR [options]
 
-Where REFACTOR_TYPE is one of: ["generic", "rspec_to_minitest_rails", "minitest_to_rspec"]
+Where REFACTOR_TYPE is one of: ["rspec_to_minitest_rails", "generic"]
 
     -p, --prompt PROMPT_FILE         Specify path to a text file that contains the ChatGPT 'system' prompt.
     -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
@@ -77,6 +91,10 @@ Where REFACTOR_TYPE is one of: ["generic", "rspec_to_minitest_rails", "minitest_
     -v, --verbose                    Show extra output and progress info
     -d, --debug                      Show debugging output to help diagnose issues
     -h, --help                       Prints this help
+
+For refactor type 'generic':
+        --output [FILE]              Write output to file instead of stdout. If no path provided will overwrite input file (will prompt to overwrite existing files)
+        --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)
 ```
 
 

data/exe/ai_refactor

@@ -14,7 +14,6 @@ supported_names = AIRefactor::Refactors.names
 option_parser = OptionParser.new do |parser|
   parser.banner = "Usage: ai_refactor REFACTOR_TYPE INPUT_FILE_OR_DIR [options]\n\nWhere REFACTOR_TYPE is one of: #{supported_names}\n\n"
 
-  # todo: support for a sort of generic process which uses a custom prompt file
   parser.on("-p", "--prompt PROMPT_FILE", String, "Specify path to a text file that contains the ChatGPT 'system' prompt.") do |f|
     options[:prompt_file_path] = f
   end
@@ -27,11 +26,11 @@ option_parser = OptionParser.new do |parser|
     options[:ai_model] = m
   end
 
-  parser.on(nil, "--temperature TEMP", Float, "Specify the temperature parameter for ChatGPT (default 0.7).") do |p|
+  parser.on("--temperature TEMP", Float, "Specify the temperature parameter for ChatGPT (default 0.7).") do |p|
     options[:ai_temperature] = p
   end
 
-  parser.on(nil, "--max-tokens MAX_TOKENS", Integer, "Specify the max number of tokens of output ChatGPT can generate. Max will depend on the size of the prompt (default 1500)") do |m|
+  parser.on("--max-tokens MAX_TOKENS", Integer, "Specify the max number of tokens of output ChatGPT can generate. Max will depend on the size of the prompt (default 1500)") do |m|
     options[:ai_max_tokens] = m
   end
 
@@ -47,18 +46,23 @@ option_parser = OptionParser.new do |parser|
     options[:debug] = true
   end
 
-  supported_refactors.each do |_name, refactorer|
-    refactorer.command_line_options.each do |option|
-      parser.on(option[:short], option[:long], option[:type], option[:help]) do |o|
-        options[option[:key]] = o
-      end
-    end
-  end
-
   parser.on("-h", "--help", "Prints this help") do
     puts parser
     exit
   end
+
+  parser.separator ""
+
+  supported_refactors.each do |name, refactorer|
+    parser.separator "For refactor type '#{name}':" if refactorer.command_line_options.size.positive?
+    refactorer.command_line_options.each do |option|
+      args = [option[:long], option[:type], option[:help]]
+      args.unshift(option[:short]) if option[:short]
+      parser.on(*args) do |o|
+        options[option[:key]] = o.nil? ? true : o
+      end
+    end
+  end
 end
 
 option_parser.parse!

data/lib/ai_refactor/base_refactor.rb

@@ -21,8 +21,26 @@ module AIRefactor
 
     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
-      self.class.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
@@ -43,17 +61,6 @@ module AIRefactor
           .tr("-", "_")
           .downcase
       end
-
-      def prompt_file_path
-        file = if options[:prompt_file_path]&.length&.positive?
-          options[:prompt_file_path]
-        else
-          File.join(File.dirname(File.expand_path(__FILE__)), "prompts", "#{refactor_name}.md")
-        end
-        file.tap do |prompt|
-          raise "No prompt file '#{prompt}' found for #{refactor_name}" unless File.exist?(prompt)
-        end
-      end
     end
   end
 end

data/lib/ai_refactor/refactors/generic.rb

@@ -5,14 +5,20 @@ module AIRefactor
     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
+          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
@@ -38,11 +44,38 @@ module AIRefactor
           return false
         end
 
-        output_content
+        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?
@@ -58,8 +91,21 @@ module AIRefactor
       end
 
       class << self
-        def prompt_file_path
-          raise "Generic refactor requires prompt file to be user specified."
+        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

data/lib/ai_refactor/refactors/rspec_to_minitest_rails.rb

@@ -35,13 +35,7 @@ module AIRefactor
         )
 
         if processor.output_exists?
-          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 test file already exists"
-            return false
-          end
+          return false unless can_overwrite_output_file?(output_path)
         end
 
         logger.verbose "Converting #{input_file}..."

data/lib/ai_refactor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ai_refactor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize