swarm_sdk 2.7.14 → 3.0.0.alpha1

data/lib/swarm_sdk/tools/scratchpad/scratchpad_write.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Tools
-    module Scratchpad
-      # Tool for writing content to scratchpad storage
-      #
-      # Stores content in volatile, shared storage for temporary communication.
-      # All agents in the swarm share the same scratchpad.
-      # Data is lost when the process ends (not persisted).
-      class ScratchpadWrite < Base
-        define_method(:name) { "ScratchpadWrite" }
-
-        description <<~DESC
-          Store content in scratchpad for temporary cross-agent communication.
-
-          ## When to Use Scratchpad
-
-          Use ScratchpadWrite to:
-          - Store detailed outputs, analysis, or results that are too long for direct responses
-          - Share information that would otherwise clutter your responses
-          - Store intermediate results during multi-step tasks
-          - Leave coordination messages for other agents
-          - Cache computed data for quick retrieval
-
-          ## Best Practices
-
-          - Choose simple, descriptive paths: 'status', 'result', 'notes/agent_x'
-          - Use hierarchical paths for organization: 'analysis/step1', 'analysis/step2'
-          - Keep entries focused - one piece of information per entry
-          - Any agent can read scratchpad content
-          - Data is lost when the swarm ends (use MemoryWrite for persistent storage)
-          - Maximum 1MB per entry
-
-          ## Examples
-
-          Good paths: 'status', 'api_analysis', 'test_results', 'notes/backend'
-          Bad paths: 'scratch/temp/file123.txt', 'output.log'
-        DESC
-
-        param :file_path,
-          desc: "Simple path for the content (e.g., 'status', 'result', 'notes/agent_x')",
-          required: true
-
-        param :content,
-          desc: "Content to store in scratchpad (max 1MB per entry)",
-          required: true
-
-        param :title,
-          desc: "Brief title describing the content",
-          required: true
-
-        class << self
-          # Create a ScratchpadWrite tool for a specific scratchpad storage instance
-          #
-          # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
-          # @return [ScratchpadWrite] Tool instance
-          def create_for_scratchpad(scratchpad_storage)
-            new(scratchpad_storage)
-          end
-        end
-
-        # Initialize with scratchpad storage instance
-        #
-        # @param scratchpad_storage [Stores::ScratchpadStorage] Shared scratchpad storage instance
-        def initialize(scratchpad_storage)
-          super() # Call RubyLLM::Tool's initialize
-          @scratchpad_storage = scratchpad_storage
-        end
-
-        # Execute the tool
-        #
-        # @param file_path [String] Path to store content
-        # @param content [String] Content to store
-        # @param title [String] Brief title
-        # @return [String] Success message with path and size
-        def execute(file_path:, content:, title:)
-          entry = scratchpad_storage.write(file_path: file_path, content: content, title: title)
-          "Stored at scratchpad://#{file_path} (#{format_bytes(entry.size)})"
-        rescue ArgumentError => e
-          validation_error(e.message)
-        end
-
-        private
-
-        attr_reader :scratchpad_storage
-
-        def validation_error(message)
-          "<tool_use_error>InputValidationError: #{message}</tool_use_error>"
-        end
-
-        # Format bytes to human-readable size
-        #
-        # @param bytes [Integer] Number of bytes
-        # @return [String] Formatted size
-        def format_bytes(bytes)
-          if bytes >= 1_000_000
-            "#{(bytes.to_f / 1_000_000).round(1)}MB"
-          elsif bytes >= 1_000
-            "#{(bytes.to_f / 1_000).round(1)}KB"
-          else
-            "#{bytes}B"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/swarm_sdk/tools/stores/read_tracker.rb

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Tools
-    module Stores
-      # ReadTracker manages read-file tracking for all agents with content digest verification
-      #
-      # This module maintains a global registry of which files each agent has read
-      # during their conversation along with SHA256 digests of the content. This enables
-      # enforcement of the "read-before-write" and "read-before-edit" rules that ensure
-      # agents have context before modifying files, AND prevents editing files that have
-      # changed externally since being read.
-      #
-      # Each agent maintains an independent map of read files to content digests.
-      module ReadTracker
-        @read_files = {} # { agent_id => { file_path => sha256_digest } }
-        @mutex = Mutex.new
-
-        class << self
-          # Register that an agent has read a file with content digest
-          #
-          # @param agent_id [Symbol] The agent identifier
-          # @param file_path [String] The absolute path to the file
-          # @param content [String] File content (for digest calculation)
-          # @return [String] The calculated SHA256 digest
-          def register_read(agent_id, file_path, content)
-            @mutex.synchronize do
-              @read_files[agent_id] ||= {}
-              digest = Digest::SHA256.hexdigest(content)
-              @read_files[agent_id][File.expand_path(file_path)] = digest
-              digest
-            end
-          end
-
-          # Check if an agent has read a file AND content hasn't changed
-          #
-          # @param agent_id [Symbol] The agent identifier
-          # @param file_path [String] The absolute path to the file
-          # @return [Boolean] true if agent read file and content matches
-          def file_read?(agent_id, file_path)
-            @mutex.synchronize do
-              return false unless @read_files[agent_id]
-
-              expanded_path = File.expand_path(file_path)
-              stored_digest = @read_files[agent_id][expanded_path]
-              return false unless stored_digest
-
-              # Check if file still exists and matches stored digest
-              return false unless File.exist?(expanded_path)
-
-              current_digest = Digest::SHA256.hexdigest(File.read(expanded_path))
-              current_digest == stored_digest
-            end
-          end
-
-          # Get all read files with digests for snapshot
-          #
-          # @param agent_id [Symbol] The agent identifier
-          # @return [Hash] { file_path => digest }
-          def get_read_files(agent_id)
-            @mutex.synchronize do
-              @read_files[agent_id]&.dup || {}
-            end
-          end
-
-          # Restore read files with digests from snapshot
-          #
-          # @param agent_id [Symbol] The agent identifier
-          # @param files_with_digests [Hash] { file_path => digest }
-          # @return [void]
-          def restore_read_files(agent_id, files_with_digests)
-            @mutex.synchronize do
-              @read_files[agent_id] = files_with_digests.dup
-            end
-          end
-
-          # Clear read history for an agent (useful for testing)
-          #
-          # @param agent_id [Symbol] The agent identifier
-          def clear(agent_id)
-            @mutex.synchronize do
-              @read_files.delete(agent_id)
-            end
-          end
-
-          # Clear all read history (useful for testing)
-          def clear_all
-            @mutex.synchronize do
-              @read_files.clear
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/swarm_sdk/tools/stores/scratchpad_storage.rb

@@ -1,273 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Tools
-    module Stores
-      # ScratchpadStorage provides volatile, shared storage
-      #
-      # Features:
-      # - Shared: All agents share the same scratchpad
-      # - Volatile: NEVER persists - all data lost when process ends
-      # - Path-based: Hierarchical organization using file-path-like addresses
-      # - Metadata-rich: Stores content + title + timestamp + size
-      # - Thread-safe: Mutex-protected operations
-      #
-      # Use for temporary, cross-agent communication within a single session.
-      class ScratchpadStorage < Storage
-        # Initialize scratchpad storage (always volatile)
-        #
-        # @param total_size_limit [Integer, nil] Maximum total size in bytes (defaults to Defaults::Storage::TOTAL_SIZE_BYTES)
-        def initialize(total_size_limit: nil)
-          super() # Initialize parent Storage class
-          @entries = {}
-          @total_size = 0
-          @total_size_limit = total_size_limit || SwarmSDK.config.scratchpad_total_size_limit
-          @mutex = Mutex.new
-        end
-
-        # Write content to scratchpad
-        #
-        # @param file_path [String] Path to store content
-        # @param content [String] Content to store
-        # @param title [String] Brief title describing the content
-        # @raise [ArgumentError] If size limits are exceeded
-        # @return [Entry] The created entry
-        def write(file_path:, content:, title:)
-          @mutex.synchronize do
-            raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
-            raise ArgumentError, "content is required" if content.nil?
-            raise ArgumentError, "title is required" if title.nil? || title.to_s.strip.empty?
-
-            content_size = content.bytesize
-
-            # Check entry size limit
-            entry_size_limit = SwarmSDK.config.scratchpad_entry_size_limit
-            if content_size > entry_size_limit
-              raise ArgumentError, "Content exceeds maximum size (#{format_bytes(entry_size_limit)}). " \
-                "Current: #{format_bytes(content_size)}"
-            end
-
-            # Calculate new total size
-            existing_entry = @entries[file_path]
-            existing_size = existing_entry ? existing_entry.size : 0
-            new_total_size = @total_size - existing_size + content_size
-
-            # Check total size limit
-            if new_total_size > @total_size_limit
-              raise ArgumentError, "Scratchpad full (#{format_bytes(@total_size_limit)} limit). " \
-                "Current: #{format_bytes(@total_size)}, " \
-                "Would be: #{format_bytes(new_total_size)}. " \
-                "Clear old entries or use smaller content."
-            end
-
-            # Create entry
-            entry = Entry.new(
-              content: content,
-              title: title,
-              updated_at: Time.now,
-              size: content_size,
-            )
-
-            # Update storage
-            @entries[file_path] = entry
-            @total_size = new_total_size
-
-            entry
-          end
-        end
-
-        # Read content from scratchpad
-        #
-        # @param file_path [String] Path to read from
-        # @raise [ArgumentError] If path not found
-        # @return [String] Content at the path
-        def read(file_path:)
-          raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
-
-          entry = @entries[file_path]
-          raise ArgumentError, "scratchpad://#{file_path} not found" unless entry
-
-          entry.content
-        end
-
-        # Delete a specific entry
-        #
-        # @param file_path [String] Path to delete
-        # @raise [ArgumentError] If path not found
-        # @return [void]
-        def delete(file_path:)
-          @mutex.synchronize do
-            raise ArgumentError, "file_path is required" if file_path.nil? || file_path.to_s.strip.empty?
-
-            entry = @entries[file_path]
-            raise ArgumentError, "scratchpad://#{file_path} not found" unless entry
-
-            # Update total size
-            @total_size -= entry.size
-
-            # Remove entry
-            @entries.delete(file_path)
-          end
-        end
-
-        # List scratchpad entries, optionally filtered by prefix
-        #
-        # @param prefix [String, nil] Filter by path prefix
-        # @return [Array<Hash>] Array of entry metadata (path, title, size, updated_at)
-        def list(prefix: nil)
-          entries = @entries
-
-          # Filter by prefix if provided
-          if prefix && !prefix.empty?
-            entries = entries.select { |path, _| path.start_with?(prefix) }
-          end
-
-          # Return metadata sorted by path
-          entries.map do |path, entry|
-            {
-              path: path,
-              title: entry.title,
-              size: entry.size,
-              updated_at: entry.updated_at,
-            }
-          end.sort_by { |e| e[:path] }
-        end
-
-        # Search entries by glob pattern
-        #
-        # @param pattern [String] Glob pattern (e.g., "**/*.txt", "parallel/*/task_*")
-        # @return [Array<Hash>] Array of matching entry metadata, sorted by most recent first
-        def glob(pattern:)
-          raise ArgumentError, "pattern is required" if pattern.nil? || pattern.to_s.strip.empty?
-
-          # Convert glob pattern to regex
-          regex = glob_to_regex(pattern)
-
-          # Filter entries by pattern
-          matching_entries = @entries.select { |path, _| regex.match?(path) }
-
-          # Return metadata sorted by most recent first
-          matching_entries.map do |path, entry|
-            {
-              path: path,
-              title: entry.title,
-              size: entry.size,
-              updated_at: entry.updated_at,
-            }
-          end.sort_by { |e| -e[:updated_at].to_f }
-        end
-
-        # Search entry content by pattern
-        #
-        # @param pattern [String] Regular expression pattern to search for
-        # @param case_insensitive [Boolean] Whether to perform case-insensitive search
-        # @param output_mode [String] Output mode: "files_with_matches" (default), "content", or "count"
-        # @return [Array<Hash>, String] Results based on output_mode
-        def grep(pattern:, case_insensitive: false, output_mode: "files_with_matches")
-          raise ArgumentError, "pattern is required" if pattern.nil? || pattern.to_s.strip.empty?
-
-          # Create regex from pattern
-          flags = case_insensitive ? Regexp::IGNORECASE : 0
-          regex = Regexp.new(pattern, flags)
-
-          case output_mode
-          when "files_with_matches"
-            # Return just the paths that match
-            matching_paths = @entries.select { |_path, entry| regex.match?(entry.content) }
-              .map { |path, _| path }
-              .sort
-            matching_paths
-          when "content"
-            # Return paths with matching lines, sorted by most recent first
-            results = []
-            @entries.each do |path, entry|
-              matching_lines = []
-              entry.content.each_line.with_index(1) do |line, line_num|
-                matching_lines << { line_number: line_num, content: line.chomp } if regex.match?(line)
-              end
-              results << { path: path, matches: matching_lines, updated_at: entry.updated_at } unless matching_lines.empty?
-            end
-            results.sort_by { |r| -r[:updated_at].to_f }.map { |r| r.except(:updated_at) }
-          when "count"
-            # Return paths with match counts, sorted by most recent first
-            results = []
-            @entries.each do |path, entry|
-              count = entry.content.scan(regex).size
-              results << { path: path, count: count, updated_at: entry.updated_at } if count > 0
-            end
-            results.sort_by { |r| -r[:updated_at].to_f }.map { |r| r.except(:updated_at) }
-          else
-            raise ArgumentError, "Invalid output_mode: #{output_mode}. Must be 'files_with_matches', 'content', or 'count'"
-          end
-        end
-
-        # Clear all entries
-        #
-        # @return [void]
-        def clear
-          @mutex.synchronize do
-            @entries.clear
-            @total_size = 0
-          end
-        end
-
-        # Get current total size
-        #
-        # @return [Integer] Total size in bytes
-        attr_reader :total_size
-
-        # Get number of entries
-        #
-        # @return [Integer] Number of entries
-        def size
-          @entries.size
-        end
-
-        # Get all entries with content for snapshot
-        #
-        # Thread-safe method that returns a copy of all entries.
-        # Used by snapshot/restore functionality.
-        #
-        # @return [Hash] { path => Entry }
-        def all_entries
-          @mutex.synchronize do
-            @entries.dup
-          end
-        end
-
-        # Restore entries from snapshot
-        #
-        # Restores entries directly without using write() to preserve timestamps.
-        # This ensures entry ordering and metadata accuracy after restore.
-        #
-        # @param entries_data [Hash] { path => { content:, title:, updated_at:, size: } }
-        # @return [void]
-        def restore_entries(entries_data)
-          @mutex.synchronize do
-            entries_data.each do |path, data|
-              # Handle both symbol and string keys from JSON
-              content = data[:content] || data["content"]
-              title = data[:title] || data["title"]
-              updated_at_str = data[:updated_at] || data["updated_at"]
-
-              # Parse timestamp from ISO8601 string
-              updated_at = Time.parse(updated_at_str)
-
-              # Create entry with preserved timestamp
-              entry = Entry.new(
-                content: content,
-                title: title,
-                updated_at: updated_at,
-                size: content.bytesize,
-              )
-
-              # Update storage
-              @entries[path] = entry
-              @total_size += entry.size
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/swarm_sdk/tools/stores/storage.rb

@@ -1,142 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Tools
-    module Stores
-      # Abstract base class for hierarchical key-value storage with metadata
-      #
-      # Provides session-scoped storage for agents with path-based organization.
-      # Subclasses implement persistence behavior (volatile vs persistent).
-      #
-      # Features:
-      # - Path-based: Hierarchical organization using file-path-like addresses
-      # - Metadata-rich: Stores content + title + timestamp + size
-      # - Search capabilities: Glob patterns and grep-style content search
-      # - Thread-safe: Mutex-protected operations
-      class Storage
-        # Represents a single storage entry with metadata
-        Entry = Struct.new(:content, :title, :updated_at, :size, keyword_init: true)
-
-        # Initialize storage
-        #
-        # Subclasses should call super() in their initialize method.
-        # This base implementation does nothing - it exists only to satisfy RuboCop.
-        def initialize
-          # Base class initialization - subclasses implement their own logic
-        end
-
-        # Write content to storage
-        #
-        # @param file_path [String] Path to store content
-        # @param content [String] Content to store
-        # @param title [String] Brief title describing the content
-        # @raise [ArgumentError] If size limits are exceeded
-        # @return [Entry] The created entry
-        def write(file_path:, content:, title:)
-          raise NotImplementedError, "Subclass must implement #write"
-        end
-
-        # Read content from storage
-        #
-        # @param file_path [String] Path to read from
-        # @raise [ArgumentError] If path not found
-        # @return [String] Content at the path
-        def read(file_path:)
-          raise NotImplementedError, "Subclass must implement #read"
-        end
-
-        # Delete a specific entry
-        #
-        # @param file_path [String] Path to delete
-        # @raise [ArgumentError] If path not found
-        # @return [void]
-        def delete(file_path:)
-          raise NotImplementedError, "Subclass must implement #delete"
-        end
-
-        # List entries, optionally filtered by prefix
-        #
-        # @param prefix [String, nil] Filter by path prefix
-        # @return [Array<Hash>] Array of entry metadata (path, title, size, updated_at)
-        def list(prefix: nil)
-          raise NotImplementedError, "Subclass must implement #list"
-        end
-
-        # Search entries by glob pattern
-        #
-        # @param pattern [String] Glob pattern (e.g., "**/*.txt", "parallel/*/task_*")
-        # @return [Array<Hash>] Array of matching entry metadata, sorted by most recent first
-        def glob(pattern:)
-          raise NotImplementedError, "Subclass must implement #glob"
-        end
-
-        # Search entry content by pattern
-        #
-        # @param pattern [String] Regular expression pattern to search for
-        # @param case_insensitive [Boolean] Whether to perform case-insensitive search
-        # @param output_mode [String] Output mode: "files_with_matches" (default), "content", or "count"
-        # @return [Array<Hash>, String] Results based on output_mode
-        def grep(pattern:, case_insensitive: false, output_mode: "files_with_matches")
-          raise NotImplementedError, "Subclass must implement #grep"
-        end
-
-        # Clear all entries
-        #
-        # @return [void]
-        def clear
-          raise NotImplementedError, "Subclass must implement #clear"
-        end
-
-        # Get current total size
-        #
-        # @return [Integer] Total size in bytes
-        def total_size
-          raise NotImplementedError, "Subclass must implement #total_size"
-        end
-
-        # Get number of entries
-        #
-        # @return [Integer] Number of entries
-        def size
-          raise NotImplementedError, "Subclass must implement #size"
-        end
-
-        protected
-
-        # Format bytes to human-readable size
-        #
-        # @param bytes [Integer] Number of bytes
-        # @return [String] Formatted size (e.g., "1.5MB", "500.0KB")
-        def format_bytes(bytes)
-          if bytes >= 1_000_000
-            "#{(bytes.to_f / 1_000_000).round(1)}MB"
-          elsif bytes >= 1_000
-            "#{(bytes.to_f / 1_000).round(1)}KB"
-          else
-            "#{bytes}B"
-          end
-        end
-
-        # Convert glob pattern to regex
-        #
-        # @param pattern [String] Glob pattern
-        # @return [Regexp] Regular expression
-        def glob_to_regex(pattern)
-          # Escape special regex characters except glob wildcards
-          escaped = Regexp.escape(pattern)
-
-          # Convert glob wildcards to regex
-          # ** matches any number of directories (including zero)
-          escaped = escaped.gsub('\*\*', ".*")
-          # * matches anything except directory separator
-          escaped = escaped.gsub('\*', "[^/]*")
-          # ? matches single character except directory separator
-          escaped = escaped.gsub('\?', "[^/]")
-
-          # Anchor to start and end
-          Regexp.new("\\A#{escaped}\\z")
-        end
-      end
-    end
-  end
-end

data/lib/swarm_sdk/tools/stores/todo_manager.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module SwarmSDK
-  module Tools
-    module Stores
-      # TodoManager provides per-agent todo list storage
-      #
-      # Each agent maintains its own independent todo list that persists
-      # throughout the agent's execution session. This allows agents to
-      # track progress on complex multi-step tasks.
-      class TodoManager
-        @storage = {}
-        @mutex = Mutex.new
-
-        class << self
-          # Get the current todo list for an agent
-          #
-          # @param agent_id [Symbol, String] Unique agent identifier
-          # @return [Array<Hash>] Array of todo items
-          def get_todos(agent_id)
-            @mutex.synchronize do
-              @storage[agent_id.to_sym] ||= []
-            end
-          end
-
-          # Set the todo list for an agent
-          #
-          # @param agent_id [Symbol, String] Unique agent identifier
-          # @param todos [Array<Hash>] Array of todo items
-          # @return [Array<Hash>] The stored todos
-          def set_todos(agent_id, todos)
-            @mutex.synchronize do
-              @storage[agent_id.to_sym] = todos
-            end
-          end
-
-          # Clear all todos for an agent
-          #
-          # @param agent_id [Symbol, String] Unique agent identifier
-          def clear_todos(agent_id)
-            @mutex.synchronize do
-              @storage.delete(agent_id.to_sym)
-            end
-          end
-
-          # Clear all todos for all agents
-          def clear_all
-            @mutex.synchronize do
-              @storage.clear
-            end
-          end
-
-          # Get summary of all agent todo lists
-          #
-          # @return [Hash] Map of agent_id => todo count
-          def summary
-            @mutex.synchronize do
-              @storage.transform_values(&:size)
-            end
-          end
-        end
-      end
-    end
-  end
-end