omniai-tools 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 404c95beb54e2092a9a694887ba55a2e8ac8ec736bed56b755cfe34d0906cf9e
-  data.tar.gz: f07bf709204ea5a472733695e45870bbbf51b5f89a7d817d290e9e926cf4a57d
+  metadata.gz: dbc1dae9ab7fe238fadd4c48d660f342e851b1803e3e33e22c487ceabd3bf32b
+  data.tar.gz: cf37310371a1711adaedea7609ce340552c7858faab4d9b60c6d26919864490a
 SHA512:
-  metadata.gz: 206fda9b71017456d3d4f6d2c590849b93bf302c298916fe64fdd9552429357b35c86a01fde359f0ff7e63fc6202429e9bf16e4c4563a61b7ddc065a77c404e8
-  data.tar.gz: c7a122e9c86e418825285c4503236eb921570980eba9c8586c509243d2bb9ee7d3bb2d0da2187f331c8c53647153c2109b258d44ed52f12b1929e8cf08d8d93e
+  metadata.gz: 766b80d9ab2b3bf459eeee00473c69f352fd4e61b70a4be9531a76b164d1e1fbc7373fe634033f19c519dc56098b77e536431d53a46bd91bde017887ed91f61a
+  data.tar.gz: 1fc747fda798976e4c13e4c0fd208a83253b61d8f1b473029e085308f7603f7d20e616f32c9b0e564952e6f48cf4e1eb10cc5570d8d6525c6c4a9728449e5b08

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 gem "factory_bot"
 gem "irb"
 gem "rake"
+gem "redcarpet"
 gem "rspec"
 gem "rspec_junit_formatter"
 gem "rubocop"

data/README.md

@@ -5,3 +5,83 @@
 [![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/omniai-tools)
 [![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://omniai-tools.ksylvest.com)
 [![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/omniai-tools)](https://circleci.com/gh/ksylvest/omniai-tools)
+
+`OmniAI::Tools` is a library of pre-built tools to simplify integrating common tasks with [OmniAI](https://github.com/ksylvest/omniai).
+
+## Disk
+
+Disk tools are focused on creating, updating, and deleting files and directories within a "root":
+
+```ruby
+require "omniai/openai"
+require "omniai/tools"
+
+print "Root (e.g. /usr/src/project): "
+root = gets.strip
+
+client = OmniAI::OpenAI::Client.new
+logger = Logger.new($stdout)
+
+tools = [
+  OmniAI::Tools::Disk::DirectoryCreateTool,
+  OmniAI::Tools::Disk::DirectoryDeleteTool,
+  OmniAI::Tools::Disk::FileCreateTool,
+  OmniAI::Tools::Disk::FileDeleteTool,
+  OmniAI::Tools::Disk::FileMoveTool,
+  OmniAI::Tools::Disk::FileReplaceTool,
+  OmniAI::Tools::Disk::FileReadTool,
+  OmniAI::Tools::Disk::FileWriteTool,
+  OmniAI::Tools::Disk::SummaryTool,
+].map { |klass| klass.new(root:, logger:) }
+
+puts "Type 'exit' or 'quit' to leave."
+
+prompt = OmniAI::Chat::Prompt.build do |builder|
+  builder.system "Use tools to manage files and directories as requested."
+end
+
+loop do
+  print "# "
+  text = gets.strip
+  break if %w[exit quit].include?(text)
+
+  prompt.user(text)
+  response = client.chat(prompt, stream: $stdout, tools:)
+  prompt.assistant(response.text)
+end
+```
+
+## Docker
+
+Docker tools are focused on running commands through Docker via Compose:
+
+```ruby
+require "omniai/openai"
+require "omniai/tools"
+
+print "Root (e.g. /usr/src/project): "
+root = gets.strip
+
+client = OmniAI::OpenAI::Client.new
+logger = Logger.new($stdout)
+
+tools = [
+  OmniAI::Tools::Docker::ComposeRunTool,
+].map { |klass| klass.new(root:, logger:) }
+
+puts "Type 'exit' or 'quit' to leave."
+
+prompt = OmniAI::Chat::Prompt.build do |builder|
+  builder.system "Use tools to interact with Docker."
+end
+
+loop do
+  print "# "
+  text = gets.strip
+  break if %w[exit quit].include?(text)
+
+  prompt.user(text)
+  response = client.chat(prompt, stream: $stdout, tools:)
+  prompt.assistant(response.text)
+end
+```

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/omniai/tools/disk/base_tool.rb

@@ -18,7 +18,6 @@ module OmniAI
 
       protected
 
-        # @param directory [Pathname]
         # @param path [String]
         #
         # @raise [SecurityError]

data/lib/omniai/tools/disk/directory_create_tool.rb

@@ -11,6 +11,8 @@ module OmniAI
 
         parameter :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
 
+        required %i[path]
+
         # @param path [String]
         #
         # @return [String]

data/lib/omniai/tools/disk/directory_delete_tool.rb

@@ -11,6 +11,8 @@ module OmniAI
 
         parameter :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
 
+        required %i[path]
+
         # @param path [String]
         #
         # @return [String]

data/lib/omniai/tools/disk/file_create_tool.rb

@@ -11,6 +11,8 @@ module OmniAI
 
         parameter :path, :string, description: "a path to the file (e.g. `./README.md`)"
 
+        required %i[path]
+
         # @param path [String]
         #
         # @return [String]

data/lib/omniai/tools/disk/file_delete_tool.rb

@@ -7,9 +7,11 @@ module OmniAI
       #   tool = OmniAI::Tools::Disk::FileDeleteTool.new(root: "./project")
       #   tool.execute(path: "./README.md")
       class FileDeleteTool < BaseTool
-        description "reads the contents of a file"
+        description "Deletes a file."
 
-        parameter :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
+        parameter :path, :string, description: "a path to the file (e.g. `./README.md`)"
+
+        required %i[path]
 
         # @param path [String]
         #

data/lib/omniai/tools/disk/file_move_tool.rb

@@ -4,17 +4,19 @@ module OmniAI
   module Tools
     module Disk
       # @example
-      #   tool = OmniAI::Tools::Disk::FileDeleteTool.new(root: "./project")
+      #   tool = OmniAI::Tools::Disk::FileMoveTool.new(root: "./project")
       #   tool.execute(
       #     old_path: "./README.txt",
       #     new_path: "./README.md",
       #   )
       class FileMoveTool < BaseTool
-        description "moves a file"
+        description "Moves a file."
 
         parameter :old_path, :string, description: "a path (e.g. `./old.rb`)"
         parameter :new_path, :string, description: "a path (e.g. `./new.rb`)"
 
+        required %i[old_path new_path]
+
         # @param old_path [String]
         # @param new_path [String]
         #

data/lib/omniai/tools/disk/file_read_tool.rb

@@ -7,10 +7,12 @@ module OmniAI
       #   tool = OmniAI::Tools::Disk::FileReadTool.new(root: "./project")
       #   tool.execute(path: "./README.md") # => "..."
       class FileReadTool < BaseTool
-        description "reads the contents of a file"
+        description "Reads the contents of a file."
 
         parameter :path, :string, description: "a path (e.g. `./main.rb`)"
 
+        required %i[path]
+
         # @param path [String]
         #
         # @return [String]

data/lib/omniai/tools/disk/file_replace_tool.rb

@@ -11,12 +11,14 @@ module OmniAI
       #     path: "README.md"
       #   )
       class FileReplaceTool < BaseTool
-        description "replace a specific string in a file (old_text => new_text)"
+        description "Replaces a specific string in a file (old_text => new_text)."
 
         parameter :old_text, :string, description: "the old text (e.g. `puts 'ABC'`)"
         parameter :new_text, :string, description: "the new text (e.g. `puts 'DEF'`)"
         parameter :path, :string, description: "a path (e.g. `./main.rb`)"
 
+        required %i[old_text new_text path]
+
         # @param path [String]
         # @param old_text [String]
         # @param new_text [String]

data/lib/omniai/tools/disk/file_write_tool.rb

@@ -7,11 +7,13 @@ module OmniAI
       #    tool = OmniAI::Tools::Disk::FileWriteTool.new(root: "./project")
       #    tool.execute(path: "./README.md", text: "Hello World")
       class FileWriteTool < BaseTool
-        description "Write the contents of a file."
+        description "Writes the contents of a file."
 
         parameter :path, :string, description: "a path for the file (e.g. `./main.rb`)"
         parameter :text, :string, description: "the text to write to the file (e.g. `puts 'Hello World'`)"
 
+        required %i[path text]
+
         # @param path [String]
         # @param text [String]
         #

data/lib/omniai/tools/disk/summary_tool.rb

@@ -7,7 +7,7 @@ module OmniAI
       #   tool = OmniAI::Tools::Disk::SummaryTool.new(root: "./project")
       #   tool.execute
       class SummaryTool < BaseTool
-        description "Summarize the contents (files and directories) of the project."
+        description "Summarizes the contents (files and directories) of the project."
 
         # @return [String]
         def execute

data/lib/omniai/tools/docker/compose_run_tool.rb

@@ -9,12 +9,12 @@ module OmniAI
       #   tool = OmniAI::Tools::Docker::ComposeRunTool.new(root: "./project")
       #   tool.execute(service: "app", command: "rspec" args: ["spec/main_spec.rb"])
       class ComposeRunTool < BaseTool
-        description "Run a command via docker with arguments on the project (e.g. `rspec spec/main_spec.rb`)."
+        description "Runs a command via Docker with arguments on the project (e.g. `rspec spec/main_spec.rb`)."
 
-        parameter :service, :string, description: "the service to run the command against (e.g. `app`)"
-        parameter :command, :string, description: "the command to run (e.g. `rspec`)"
-        parameter :args, :array, description: "the arguments for the command",
-          items: OmniAI::Tool::Property.string(description: "an argument for the command (e.g. `spec/main_spec.rb`)")
+        parameter :service, :string, description: "The service to run the command on (e.g. `app`)."
+        parameter :command, :string, description: "The command to run (e.g. `rspec`)."
+        parameter :args, :array, description: "The arguments for the command.",
+          items: OmniAI::Tool::Property.string(description: "An argument for the command (e.g. `spec/main_spec.rb`).")
 
         # @param service [String]
         # @param command [String]

data/lib/omniai/tools/version.rb

@@ -2,6 +2,6 @@
 
 module OmniAI
   module Tools
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai-tools
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-04-22 00:00:00.000000000 Z
+date: 2025-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniai
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A set of tools built for usage with OmniAI.
 test_files: []