aigency 0.2.0 → 0.4.0

data/lib/aigency/tempdir/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class List < Tool
+      description "List all files in the temp directory"
+
+      def execute
+        aigent.log.puts "[Tempdir::List]"
+        {
+          success: true,
+          absolute_paths: Dir.glob(File.join(PATH, '**', '*'))
+        }
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/read.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Read < Tool
+      include Helpers
+
+      description "Read a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The file to read"
+      end
+
+      def execute(filename:)
+        aigent.log.puts "[Tempdir::Read] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        # @todo Hardcoded max size
+        if File.size(absolute_path) > 500_000
+          { success: false, error: "File is too large to read (max 500000 bytes)"}
+        else
+          {
+            success: true,
+            absolute_path: absolute_path,
+            content: File.read(File.join(PATH, filename))
+          }
+        end
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/size.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Size < Tool
+      include Helpers
+
+      description "Get the size of a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The file to measure"
+      end
+
+      def execute(filename:)
+        aigent.log.puts "[Tempdir::Read] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        {
+          success: true,
+          absolute_path: absolute_path,
+          size: File.size(absolute_path)
+        }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/tempdir/write.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Tempdir
+    class Write < Tool
+      include Helpers
+
+      description "Write a file in the temp directory"
+
+      parameters do
+        string :filename, description: "The filename to write"
+        string :content, description: "The file's content"
+      end
+
+      def execute(filename:, content:)
+        aigent.log.puts "[Tempdir::Write] #{filename}"
+        absolute_path = expand_in_tempdir(filename)
+        File.write absolute_path, content
+        {
+          success: true,
+          absolute_path: absolute_path
+        }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/tempdir.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'fileutils'
+
+module Aigency
+  module Tempdir
+    require 'aigency/tempdir/helpers'
+    require 'aigency/tempdir/list'
+    require 'aigency/tempdir/read'
+    require 'aigency/tempdir/write'
+    require 'aigency/tempdir/size'
+
+    PATH = Dir.mktmpdir
+    TOOLS = [List, Read, Write, Size]
+
+    at_exit { FileUtils.rm_rf PATH }
+  end
+end

data/lib/aigency/tool.rb

@@ -5,5 +5,10 @@ module Aigency
   #
   class Tool < RubyLLM::Tool
     include Usability
+
+    # class << self
+    #   alias desc description
+    #   alias params parameters
+    # end
   end
 end

data/lib/aigency/usability.rb

@@ -2,6 +2,7 @@
 
 module Aigency
   module Usability
+    # @return [Aigent]
     attr_reader :aigent
 
     def initialize(aigent)

data/lib/aigency/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aigency
-  VERSION = "0.2.0"
+  VERSION = '0.4.0'
 end

data/lib/aigency/workspace/cat.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Cat < Cmd
+      description 'Run the `cat` shell command in your workspace'
+
+      def command = 'cat'
+    end
+  end
+end

data/lib/aigency/workspace/cmd.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Aigency
+  module Workspace
+    class Cmd < Tool
+      include Helpers
+
+      # @abstract
+      # @return [String]
+      def command
+        raise 'Not implemented'
+      end
+
+      def non_path_arguments = []
+
+      def prohibited_arguments = []
+
+      def execute(directory: '.', arguments: [])
+        aigent.log.puts "[Workspace::Shell] #{command} #{arguments.inspect}"
+        if any_prohibited?(arguments)
+          return { success: false, error: "Permission denied: the following arguments to `#{command}` are prohibited: #{prohibited_arguments.inspect}" }
+        end
+        resolved = expand_in_workspace(directory)
+        if arguments != ['--help'] && arguments[0, non_path_arguments.length].any? { |arg| arg.start_with?('-') }
+          return { success: false, error: non_path_argument_error }
+        end
+        validate_path_arguments(arguments, non_path_arguments.length)
+        output, error, result = Open3.capture3(command, *arguments, chdir: resolved)
+        { success: result.success?, stdout: output, stderr: error }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}" }
+      end
+
+      def self.inherited other
+        other.parameters do
+          string :directory, description: "The working directory relative to workspace", required: false
+          array :arguments, of: :string, description: "Command arguments", required: false
+        end
+      end
+
+      private
+
+      def non_path_argument_error
+        arg_count = if non_path_arguments.length > 1
+          "#{non_path_arguments.length} arguments"
+        else
+          'argument'
+        end
+        "Permission denied: first #{arg_count} must be [#{non_path_arguments.join(', ')}] unless the only argument is `--help`"
+      end
+
+      def any_prohibited?(arguments)
+        arguments.any? { |arg| arg.start_with?(*prohibited_arguments) }
+      end
+    end
+  end
+end

data/lib/aigency/workspace/copy_tempdir_file.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Aigency
+  module Workspace
+    class CopyTempdirFile < Tool
+      include Tempdir::Helpers
+      include Workspace::Helpers
+
+      description 'Copy a file from tempdir to workspace'
+
+      parameters do
+        string :tempdir_source, description: "A source filename in tempdir", required: true
+        string :workspace_dest, description: "A destination filename in workspace", required: true
+      end
+
+      def execute(tempdir_source:, workspace_dest:)
+        aigent.log.puts "[Workspace::CopyTempdirFile] #{tempdir_source.inspect} #{workspace_dest.inspect}"
+        abs_tempdir = expand_in_tempdir(tempdir_source)
+        abs_workspace = expand_in_workspace(workspace_dest)
+        FileUtils.copy_file abs_tempdir, abs_workspace
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}"}
+      end
+    end
+  end
+end

data/lib/aigency/workspace/cp.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Cp < Cmd
+      description 'Run the `cp` shell command in your workspace'
+
+      def command = 'cp'
+    end
+  end
+end

data/lib/aigency/workspace/diff.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Diff < Cmd
+      description 'Run the `diff` shell command in your workspace'
+
+      def command = 'diff'
+    end
+  end
+end

data/lib/aigency/workspace/grep.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Grep < Cmd
+      description 'Run the `grep` shell command in your workspace'
+
+      def command = 'grep'
+
+      def non_path_arguments = %w[PATTERN]
+
+      def prohibited_arguments = %w[-f --file]
+    end
+  end
+end

data/lib/aigency/workspace/head.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Head < Cmd
+      description 'Run the `head` shell command in your workspace'
+
+      def command = 'head'
+    end
+  end
+end

data/lib/aigency/workspace/helpers.rb

@@ -3,21 +3,58 @@
 module Aigency
   module Workspace
     module Helpers
+      module_function
+
       # @!method aigent
       #   @abstract
       #   @return [Aigency::Aigent]
 
-      # Expand a path relative to the aigent's workspace directory.
+      # Expand a path relative to the aigent's workspace.
       #
       # @raise [PathError] if the expanded path is not inside the workspace
       # @param path [String]
       # @return [String]
-      def expand_to_workspace(path)
+      def expand_in_workspace(path)
         workspace = aigent.data('workspace')
         resolved = File.expand_path(path, workspace)
         return resolved if resolved == workspace || resolved.start_with?("#{workspace}/")
+        raise PathError, "Permission denied: `#{path}` is not relative to your workspace"
+      end
+
+      # @raise [PathError] if the expanded path is not inside the workspace
+      # @param arguments [Array<String>]
+      # @param start [Integer]
+      # @return [void]
+      def validate_path_arguments(arguments, start = 0)
+        current = 0
+        glued_shorts = arguments.select { |arg| arg =~ /^-[^\-].+/ }
+        unless glued_shorts.empty?
+          raise PathError, "Permission denied: glued short options (#{glued_shorts.inspect}) are not allowed"
+        end
+        workspace = aigent.data('workspace')
+        path_arguments(arguments).each do |arg|
+          if !arg.start_with?('-')
+            current += 1
+            next unless current > start
+          end
+          path = split_path_part(arg)
+          resolved = File.expand_path(path, workspace)
+          next if resolved == workspace || resolved.start_with?("#{workspace}/")
+          raise PathError, "Permission denied: `#{path}` is not relative to your workspace"
+        end
+      end
+
+      def path_arguments(arguments)
+        arguments.reject { |arg| arg =~ /^-[^\-]$/ || (arg.start_with?('--') && !arg.include?('=')) }
+      end
 
-        raise PathError, "Permission denied: `#{path}` is not relative to your root workspace"
+      def split_path_part argument
+        return argument unless argument.start_with?('-')
+        if argument.start_with?('--')
+          argument.split('=', 2).last
+        else
+          argument[2..]
+        end
       end
     end
   end

data/lib/aigency/workspace/ls.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Ls < Cmd
+      description 'Run the `ls` shell command in your workspace'
+
+      def command = 'ls'
+    end
+  end
+end

data/lib/aigency/workspace/mkdir.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Mkdir < Cmd
+      description 'Run the `mkdir` shell command in your workspace'
+
+      def command = 'mkdir'
+    end
+  end
+end

data/lib/aigency/workspace/mv.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Mv < Cmd
+      description 'Run the `mv` shell command in your workspace'
+
+      def command = 'mv'
+    end
+  end
+end

data/lib/aigency/workspace/rm.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Rm < Cmd
+      description 'Run the `rm` shell command in your workspace'
+
+      def command = 'rm'
+    end
+  end
+end

data/lib/aigency/workspace/tail.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Tail < Cmd
+      description 'Run the `tail` shell command in your workspace'
+
+      def command = 'tail'
+    end
+  end
+end

data/lib/aigency/workspace/wc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Aigency
+  module Workspace
+    class Wc < Cmd
+      description 'Run the `wc` shell command in your workspace'
+
+      def command = 'wc'
+
+      def prohibited_arguments = %w[--files0-from]
+    end
+  end
+end

data/lib/aigency/workspace/write.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Aigency
+  module Workspace
+    # @note Unlike most of the Workspace tools, this one does not execute a shell
+    #   command. It uses ruby's File module instead.
+    #
+    class Write < Tool
+      include Helpers
+
+      description 'Write or append to a file in the workspace'
+
+      parameters do
+        string :filename, description: "The filename relative to the workspace", required: true
+        string :content, description: "The data to write to the file", required: true
+        string :append, description: "Append if true or overwrite if false", required: true
+      end
+
+      def execute(filename:, content:, append:)
+        aigent.log.puts "[Workspace::Write] #{filename}"
+        resolved = expand_in_workspace(filename)
+        write_mode = if append
+          "a"
+        else
+          "w"
+        end
+        File.write resolved, content, mode: "#{write_mode}b"
+        { success: true, filename: filename }
+      rescue StandardError => e
+        { success: false, error: "[#{e.class}] #{e.message}" }
+      end
+    end
+  end
+end

data/lib/aigency/workspace.rb

@@ -3,13 +3,26 @@
 module Aigency
   module Workspace
     require 'aigency/workspace/helpers'
-    require 'aigency/workspace/directory_deleter'
-    require 'aigency/workspace/directory_reader'
-    require 'aigency/workspace/file_reader'
-    require 'aigency/workspace/file_writer'
+    require 'aigency/workspace/cmd'
+    require 'aigency/workspace/cat'
+    require 'aigency/workspace/cp'
+    require 'aigency/workspace/diff'
+    require 'aigency/workspace/grep'
+    require 'aigency/workspace/ls'
+    require 'aigency/workspace/mkdir'
+    require 'aigency/workspace/mv'
+    require 'aigency/workspace/rm'
+    require 'aigency/workspace/wc'
+    require 'aigency/workspace/write'
+    require 'aigency/workspace/copy_tempdir_file'
 
-    class PathError < RuntimeError; end
+    Plugin.register Plugin.new(
+      'workspace',
+      directories: ['data/workspace'],
+      tools: [Cat, Cp, Diff, Grep, Ls, Mkdir, Mv, Rm, Wc, Write, CopyTempdirFile],
+      config: <<~FILE
+        prompt: "The workspace tools provide access to a readable and writeable directory."
+      FILE
+    )
   end
-
-  Tools.mkdir_p 'data/workspace'
 end

data/lib/aigency.rb

@@ -2,20 +2,23 @@
 
 require 'ruby_llm'
 
-# Core
-require 'aigency/version'
-require 'aigency/usability'
-require 'aigency/tool'
-require 'aigency/tools'
-require 'aigency/aigent'
-require 'aigency/shell'
-
-# Extensions
-require 'aigency/workspace'
-
 module Aigency
+  class PathError < ArgumentError; end
+
   GEM_PATH = File.absolute_path(File.join(__dir__, '..'))
 
-  class Error < StandardError; end
-  # Your code goes here...
+  # Core
+  require 'aigency/version'
+  require 'aigency/usability'
+  require 'aigency/tool'
+  require 'aigency/delegator'
+  require 'aigency/plugin'
+  require 'aigency/aigent'
+  require 'aigency/shell'
+  require 'aigency/rake'
+
+  # Plugins and Tools
+  require 'aigency/sandbox'
+  require 'aigency/tempdir'
+  require 'aigency/workspace'
 end

data/scaffold/{Rakefile → aigent/aigent.rake}

@@ -1,7 +1,4 @@
-require "bundler/setup"
-require 'yaml'
-require 'dotenv/load'
-require 'aigency'
+# frozen_string_literal: true
 
 desc "Run a prompt from a file"
 task :load, [:filename] do |_, args|
@@ -17,13 +14,7 @@ task :load, [:filename] do |_, args|
   end
 end
 
-desc "Talk to the aigent"
-task :say, [:text] do |_, args|
-  aigent = Aigency::Aigent.new('.')
-  aigent.stream args[:text]
-end
-
-desc "Set up aigent configurations"
+desc "Set up aigent plugins"
 task :setup do
   aigent = Aigency::Aigent.new('.')
   aigent.setup

data/scaffold/enlist/.env.example

@@ -0,0 +1,4 @@
+# Environment variables to load into aigent config files
+
+OPENAI_API_BASE=https://api.openai.com/v1
+OPENAI_API_KEY=change_me

data/scaffold/{.gitignore → enlist/.gitignore}

@@ -1 +1,2 @@
 data
+.env

data/scaffold/{Gemfile → enlist/Gemfile}

@@ -7,4 +7,4 @@ gem "rake", "~> 13.0"
 gem "whenever", "~> 1.1"
 
 gem "ruby_llm"
-gem "aigency", path: "../aigency"
+gem "aigency"