ask-tools-shell 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03ed1e1f856f94afa4d5f5dc4b8fb278ad2598ddc6b7d698606c035a9e4034a9
-  data.tar.gz: a040e94935e8a1a5e03530f84e225ee6f55e662fc1d2d1ad3840bf4bcc6e168d
+  metadata.gz: eea08734ef4ad1040ba2c9f2e7b615ae9931bb5e1d83dcb893e509487e603eaf
+  data.tar.gz: 47bda8b63b21e23fef543a5142658b363fd7758e01cd37921d4d880c0804d901
 SHA512:
-  metadata.gz: d8718eb919c2eec978e61c081a036cfbf34cb9adcc829bc0b4637fe490a566f9e573de48a6e327064558868b6abf351f9373178700e5d662b80f6cb128ad788c
-  data.tar.gz: 95312eb2e6b6db1dafca32d8bf074a9d789c4a3cca13c30ed16e116a03e726f308250f08d9292fb7f7f05bed829cd7e11bb792370376e86bb46f938a1b42513c
+  metadata.gz: 75d972a45b9ecd3310c6693e0cd958745edb2af065dfdf366446bb7c4799d3359c3ff12d45dc58831eb3b59e88015a2221f0bec1c0857da6f755c2e1f32c7a4b
+  data.tar.gz: e5e8e83cb62a01e0ca737862917c559e9bade010f5104bb130f3ac8b44e7a615f1f6618e2ff30cde382caeb8cae186ed1da0c010f8f541bf884251667f29ab60

data/lib/ask/tools/shell/edit.rb

@@ -2,11 +2,66 @@
 
 module Ask
   module Tools
-    # Edit a file by replacing exact text.
-    # Uses exact string matching — provide enough surrounding context for uniqueness.
+    module Shell
+      # Pluggable operations for the Edit tool.
+      module EditOperations
+        def read_file(path)
+          File.read(path)
+        end
+
+        def write_file(path, content)
+          File.write(path, content)
+        end
+
+        def file_exist?(path)
+          File.exist?(path)
+        end
+
+        def file?(path)
+          File.file?(path)
+        end
+
+        def file_size(path)
+          File.size(path)
+        end
+
+        def expand_path(path)
+          File.expand_path(path)
+        end
+      end
+
+      class DefaultEditOperations
+        include EditOperations
+      end
+
+      # Strip UTF-8 BOM from content. Returns { bom: String, text: String }.
+      def self.strip_bom(content)
+        bom = content.byteslice(0, 3) == "\xEF\xBB\xBF" ? content.byteslice(0, 3) : ""
+        [bom, bom.empty? ? content : content.byteslice(3..)]
+      end
+
+      # Detect the dominant line ending in content.
+      def self.detect_line_ending(content)
+        crlf = content.count("\r\n")
+        lf = content.count("\n") - crlf
+        crlf > lf ? "\r\n" : "\n"
+      end
+
+      # Normalize line endings to LF.
+      def self.normalize_line_endings(content)
+        content.gsub("\r\n", "\n").gsub("\r", "\n")
+      end
+
+      # Restore original line endings after normalization.
+      def self.restore_line_endings(content, original_ending)
+        return content if original_ending == "\n"
+        content.gsub("\n", original_ending)
+      end
+    end
+
+    # Edit a file by replacing exact text. Supports BOM, line-ending preservation.
     class Edit < Ask::Tool
-      description "Edit a file by replacing exact text. " \
-                   "Uses exact string matching — provide enough surrounding context for uniqueness."
+      description "Edit a file by replacing exact text."
 
       param :path, type: :string, desc: "Absolute path to the file", required: true
       param :old_string, type: :string, desc: "Exact text to replace", required: true
@@ -15,24 +70,34 @@ module Ask
 
       MAX_FILE_SIZE = 1_000_000
 
+      attr_writer :operations
+
+      def operations
+        @operations ||= Shell::DefaultEditOperations.new
+      end
+
       def execute(path:, old_string:, new_string:, replace_all: false)
-        path = File.expand_path(path)
+        path = operations.expand_path(path)
 
-        unless File.exist?(path)
-          return Ask::Result.error(message: "File does not exist: #{path}")
+        unless operations.file_exist?(path)
+          return Ask::Result.error(message: "File does not exist: " + path)
         end
 
-        unless File.file?(path)
-          return Ask::Result.error(message: "Not a file: #{path}")
+        unless operations.file?(path)
+          return Ask::Result.error(message: "Not a file: " + path)
         end
 
-        if File.size(path) > MAX_FILE_SIZE
+        size = operations.file_size(path)
+        if size > MAX_FILE_SIZE
           return Ask::Result.error(
-            message: "File too large (#{File.size(path)} bytes). Maximum is #{MAX_FILE_SIZE} bytes."
+            message: "File too large (#{size} bytes). Maximum is #{MAX_FILE_SIZE} bytes."
           )
         end
 
-        content = File.read(path)
+        raw = operations.read_file(path)
+        bom, content = Shell.strip_bom(raw)
+        original_ending = Shell.detect_line_ending(content)
+        content = Shell.normalize_line_endings(content)
 
         if replace_all
           count = content.scan(old_string).size
@@ -45,7 +110,11 @@ module Ask
           content = content.sub(old_string, new_string)
         end
 
-        File.write(path, content)
+        # Restore line endings and re-add BOM
+        content = Shell.restore_line_endings(content, original_ending)
+        content = bom + content
+
+        operations.write_file(path, content)
         Ask::Result.ok(data: { path: path, replacements: count },
                         metadata: { path: path, replacements: count })
       end

data/lib/ask/tools/shell/file_mutation_queue.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Ask
+  module Tools
+    module Shell
+      # Queues file mutations and applies them atomically.
+      # Rollback on any failure — no partial writes.
+      #
+      #   queue = FileMutationQueue.new
+      #   queue.stage("path/to/file.rb", ->(content) {
+      #     content.gsub("old", "new")
+      #   })
+      #   queue.apply!  # reads all staged files, applies transforms, writes back
+      #
+      class FileMutationQueue
+        class ApplyError < StandardError; end
+
+        def initialize(operations: nil)
+          @staged = []
+          @operations = operations || DefaultEditOperations.new
+        end
+
+        # Stage a mutation for a file.
+        # @param path [String] absolute path to the file
+        # @yield [content] raw file content, returns modified content
+        # @yieldparam content [String] the original file content
+        # @yieldreturn [String] the modified content
+        def stage(path, &block)
+          @staged << { path: File.expand_path(path), block: block }
+        end
+
+        # Apply all staged mutations atomically.
+        # Reads all files, applies transforms, then writes all back.
+        # If any write fails, all written files are rolled back to original.
+        # @return [Array<Hash>] results with :path, :original_size, :new_size, :success
+        # @raise [ApplyError] if any mutation fails (after rollback)
+        def apply!
+          snapshots = []
+
+          # Phase 1: read all files and apply transforms
+          @staged.each do |entry|
+            path = entry[:path]
+            original = @operations.read_file(path)
+            modified = entry[:block].call(original)
+            snapshots << { path: path, original: original, modified: modified }
+          end
+
+          # Phase 2: write all files, track rollback info
+          written = []
+          begin
+            snapshots.each do |s|
+              @operations.write_file(s[:path], s[:modified])
+              written << s[:path]
+            end
+          rescue => e
+            # Rollback: restore originals for files we already wrote
+            written.each do |path|
+              snapshot = snapshots.find { |s| s[:path] == path }
+              @operations.write_file(path, snapshot[:original]) if snapshot
+            rescue => rb_e
+              $stderr.puts "[FileMutationQueue] Rollback failed for #{path}: #{rb_e.message}"
+            end
+            raise ApplyError, "Mutation failed at #{e.class}: #{e.message}. Rolled back #{written.size} files."
+          end
+
+          snapshots.map do |s|
+            { path: s[:path], original_size: s[:original].length,
+              new_size: s[:modified].length, success: true }
+          end
+        end
+
+        # Clear all staged mutations without applying.
+        def clear!
+          @staged.clear
+        end
+
+        # Number of staged mutations.
+        def size
+          @staged.size
+        end
+      end
+    end
+  end
+end

data/lib/ask/tools/shell/version.rb

@@ -3,7 +3,7 @@
 module Ask
   module Tools
     module Shell
-      VERSION = "0.2.2"
+      VERSION = "0.3.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-tools-shell
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kaka Ruto
@@ -94,6 +94,7 @@ files:
 - lib/ask/tools/shell/bash.rb
 - lib/ask/tools/shell/code.rb
 - lib/ask/tools/shell/edit.rb
+- lib/ask/tools/shell/file_mutation_queue.rb
 - lib/ask/tools/shell/glob.rb
 - lib/ask/tools/shell/grep.rb
 - lib/ask/tools/shell/read.rb