internator 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af75a509f24238b06b9081ec89eda9dcf3981ec697fc1dd0e1b6287ee86afff
-  data.tar.gz: 1e105ebea5a252205ef570a996ede9759c072d0f4ae58555813ec291458d6b66
+  metadata.gz: 9f6853d7e223f60aa6d4ea55bde5b3c5f3ba13b7f349b2f3029efd25c97b4ba6
+  data.tar.gz: 442f68165403712347f11e182aa5c460762568d3f50d7efbb347acf4e783c04c
 SHA512:
-  metadata.gz: 69d1281c009c468e94937e19a45fc68238b3bdb0bdb8f35b6e401882f8b9552c5dc992ff65b30f1ffac80511edd9aedccc6375b403dcb781c6279bd610811bad
-  data.tar.gz: 17d16892a135a1ae0d92be8f674329cdafe50f978726387347e73e86e7e6b6f4f3c1cc69e3e164733a8d981ae7fb1191035ec91ae50c42486896793843ae27de
+  metadata.gz: 909efaf0ae3e29c473356f4a07e815a615488c32b138d3c06e502f82bfd748726a24f9c7151452825153305aeab739819429967612fddfd477e78701f713e0d7
+  data.tar.gz: bcc2c29ef1b5c197d45219c2ed4bea00beb520d40fe60c3f8b1b82a22be1ded73b937719620ad1fb45086874451767c395d843bd4ad43f45a34864b38e3c0f18

data/README.md

@@ -7,7 +7,7 @@ Internator is a Ruby-based CLI tool that automates iterative pull request improv
  ## Requirements
 
  - Ruby (>= 2.5).
- - [Codex CLI](https://github.com/openai/codex) installed.
+ - [Codex CLI](https://github.com/openai/codex) installed (>= 0.3.0).
  - Environment variable `OPENAI_API_KEY` set to your OpenAI API key.
 
  ## Installation
@@ -17,15 +17,15 @@ gem install internator
 ```
 
  ## Usage
-
-Push to Github your new empty branch and run the `internator` command:
+Create your new empty branch and run the `internator` command:
 
 ```bash
-internator "<PR Objectives>" [delay_mins]
+internator "<PR Objectives>" [delay_mins] [parent_branch]
 ```
 
- - `<PR Objectives>`: Description of what the pull request should achieve.
- - `[delay_mins]`: (Optional) Minutes to wait between iterations (default: 0).
+- `<PR Objectives>`: Description of what the pull request should achieve.
+- `[delay_mins]`: (Optional) Minutes to wait between commits (default: 0).
+- `[parent_branch]`: (Optional) Branch name to diff against (default: detected repository default branch).
 
 Example:
 ```bash
@@ -33,9 +33,22 @@ internator "Refactor authentication flow and add tests" 10
 ```
 For more detailed usage tips, see the [Usage Tips wiki page](https://github.com/AlexLarra/internator/wiki/Usage-tips).
 
- ## Contributing
+## Configuration
+
+Internator reads custom instructions from a YAML file at `~/.internator_config.yml`. The file must define an `instructions` key whose value is the instruction text. For example:
+
+```yaml
+# ~/.internator_config.yml
+instructions: |
+  1. Do not overuse code comments; if the method name says it all, comments are not necessary.
+  2. Please treat files as if Vim were saving them with `set binary` and `set noeol`, i.e. do not add a final newline at the end of the file.
+```
+
+When present, Internator will use these instructions instead of the built-in defaults.
+
+## Contributing
 
- Feel free to open issues or submit pull requests.
+Feel free to open issues or submit pull requests.
 
  ## License
 

data/lib/internator/cli.rb

@@ -2,10 +2,54 @@ require "net/http"
 require "uri"
 require "json"
 require "tempfile"
+require "yaml"
 
 module Internator
   # Command-line interface for the Internator gem
   class CLI
+    # Configuration file for custom options (YAML format).
+    CONFIG_FILE = File.expand_path('~/.internator_config.yml')
+
+    def self.config
+      @config ||= begin
+        if File.exist?(CONFIG_FILE)
+          YAML.load_file(CONFIG_FILE)
+        else
+          {}
+        end
+      rescue => e
+        warn "⚠️ Could not parse config file #{CONFIG_FILE}: #{e.message}"
+        {}
+      end
+    end
+
+    # Load custom instructions from config or fall back to built-in defaults
+    def self.instructions
+      main = <<~MAIN_INSTRUCTIONS
+        1. If there are changes in the PR, first check if it has already been completed; if so, do nothing.
+        2. Make ONLY one incremental change.
+        3. Prioritize completing main objectives.
+      MAIN_INSTRUCTIONS
+
+      # Load custom instructions from ~/.internator_config.yml or fall back to built-in defaults
+      secondary =
+        if config.is_a?(Hash) && config['instructions'].is_a?(String)
+          config['instructions'].strip
+        else
+          <<~SECONDARY_INSTRUCTIONS
+            1. Do not overuse code comments; if the method name says it all, comments are not necessary.
+            2. Please treat files as if Vim were saving them with `set binary` and `set noeol`, i.e. do not add a final newline at the end of the file.
+          SECONDARY_INSTRUCTIONS
+        end
+
+      <<~INSTRUCTIONS.chomp
+      Main instructions:
+      #{main}
+      Secondary instructions:
+      #{secondary}
+      INSTRUCTIONS
+    end
+
     def self.run(args = ARGV)
       unless system("which codex > /dev/null 2>&1")
         abort "❌ 'codex' CLI is not installed or not in PATH. Please install it from https://github.com/openai/codex"
@@ -15,16 +59,42 @@ module Internator
         abort "❌ OPENAI_API_KEY not set. Please set the environment variable."
       end
 
-      if args.empty? || args.size > 2
-        abort "❌ Usage: internator \"<PR Objectives>\" [delay_mins]"
+      # Parse arguments: objectives, optional delay (minutes), optional parent_branch
+      if args.empty? || args.size > 3
+        abort "❌ Usage: internator \"<PR Objectives>\" [delay_mins] [parent_branch]"
       end
 
       objectives = args[0]
-      delay_mins = if args[1]
-                     Integer(args[1]) rescue abort("❌ Invalid delay_mins: must be an integer")
-                   else
-                     0
-                   end
+      delay_mins = 0
+      parent_branch = nil
+      case args.size
+      when 2
+        # single extra arg: integer delay or parent branch
+        begin
+          delay_mins = Integer(args[1])
+        rescue ArgumentError
+          parent_branch = args[1]
+        end
+      when 3
+        delay_mins = Integer(args[1]) rescue abort("❌ Invalid delay_mins: must be an integer")
+        parent_branch = args[2]
+      end
+
+      remote, default_base = git_detect_default_base&.split("/", 2)
+      branch = git_current_branch
+
+      abort "❌ Git remote is not detected." unless remote
+      abort "❌ Git default branch is not detected." unless default_base
+
+      if branch == default_base
+        abort "❌ You are on the default branch '#{default_base}'. Please create a new branch before running Internator."
+      end
+
+      if parent_branch && !system("git rev-parse --verify --quiet #{parent_branch} > /dev/null 2>&1")
+        abort "❌ Specified parent branch '#{parent_branch}' does not exist."
+      end
+
+      git_upstream(remote, branch)
 
       iteration = 1
       Signal.trap("INT") do
@@ -35,15 +105,14 @@ module Internator
       begin
         loop do
           puts "\n🌀 Iteration ##{iteration} - #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}"
-          exit_code = codex_cycle(objectives, iteration)
+
+          exit_code = codex_cycle(objectives, iteration, remote, default_base, branch, parent_branch)
           if exit_code != 0
-            puts "🚨 Codex process exited with code #{exit_code}. Stopping."
-            break
+            abort "🚨 Codex process exited with code #{exit_code}. Stopping."
           end
 
           if `git status --porcelain`.strip.empty?
-            puts "🎉 Objectives completed; no new changes. Exiting loop..."
-            break
+            abort "🎉 Objectives completed; no new changes. Exiting loop..."
           end
 
           auto_commit
@@ -59,7 +128,7 @@ module Internator
     end
 
     # Detect the repository's default branch across remotes (e.g., main, master, develop)
-    def self.detect_default_base
+    def self.git_detect_default_base
       remotes = `git remote`.split("\n").reject(&:empty?)
       remotes.unshift('origin') unless remotes.include?('origin')
       remotes.each do |remote|
@@ -75,23 +144,27 @@ module Internator
       nil
     end
 
-    # Executes one Codex iteration by diffing against the appropriate base branch
-    def self.codex_cycle(objectives, iteration)
-      # Determine configured upstream and current branch name
+    def self.git_current_branch
+      `git rev-parse --abbrev-ref HEAD`.strip
+    end
+
+    def self.git_upstream(remote, branch)
       upstream = `git rev-parse --abbrev-ref --symbolic-full-name @{u} 2>/dev/null`.strip
-      current_branch = `git rev-parse --abbrev-ref HEAD`.strip
-      # Choose diff base:
-      # 1) If upstream is tracking current branch, use remote default branch
-      # 2) Else if upstream exists, diff against that
-      # 3) Otherwise fallback to remote default branch or master
-      if !upstream.empty? && upstream.split('/').last == current_branch
-        base = detect_default_base || upstream
-      elsif !upstream.empty?
-        base = upstream
-      else
-        base = detect_default_base || 'master'
+
+      if upstream.empty?
+        # As upstream is not configured, push the current branch and set upstream to remote
+        puts "🔄 No upstream configured for branch '#{branch}'. Sending to #{remote}..."
+        system("git push -u #{remote} #{branch}")
+        upstream = `git rev-parse --abbrev-ref --symbolic-full-name @{u} 2>/dev/null`.strip
       end
-      # Get the diff against the chosen base
+
+      upstream
+    end
+
+    # Executes one Codex iteration by diffing against the parent or default branch
+    def self.codex_cycle(objectives, iteration, remote, default_base, branch, parent_branch = nil)
+      # Determine base branch: user-specified parent or detected default
+      base = parent_branch || default_base
       current_diff = `git diff #{base} 2>/dev/null`
       current_diff = "No initial changes" if current_diff.strip.empty?
       prompt = <<~PROMPT
@@ -99,12 +172,7 @@ module Internator
         Iteration: #{iteration}
         Current Pull Request: #{current_diff}
 
-        Instructions:
-        1. If there are changes in the PR, first check if it has already been completed; if so, do nothing.
-        2. Make ONLY one incremental change.
-        3. Prioritize completing main objectives.
-        4. Do not overuse code comments; if the method name says it all, comments are not necessary.
-        5. Please treat files as if Vim were saving them with `set binary` and `set noeol`, i.e. do not add a final newline at the end of the file.
+        #{instructions}
       PROMPT
 
       CodexService.new(prompt).call

data/lib/internator/version.rb

@@ -1,3 +1,3 @@
 module Internator
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: internator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - AlexLarra