omniai-tools 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04d1c28a8b8a92c2cc6c0ada9976d58ee2aed291fe25368356ce9a055b14cc7e
-  data.tar.gz: 5afcc660cd72ef9ed7cea14fb6478a3239af14d8e519e3ba2bb89c32ccfaeb97
+  metadata.gz: dbc1dae9ab7fe238fadd4c48d660f342e851b1803e3e33e22c487ceabd3bf32b
+  data.tar.gz: cf37310371a1711adaedea7609ce340552c7858faab4d9b60c6d26919864490a
 SHA512:
-  metadata.gz: f1331d0fc5ed4b89072e8d793620b7531d240556bca49be4a6a9b16e3368a96df3d8ca7a45c4e50198d97850b50ee13319875d4a8152ea8e7c93676d3eb81653
-  data.tar.gz: 39ac4a40cbcafe9876e51c9a7a5f8b63c3d51c9bfc7f63afe6a47e209ed0ee6acbdb8d7c5845e3f9b7fab3ed6dac8eb946eda1a69d900f8a3d897cee67bb3b52
+  metadata.gz: 766b80d9ab2b3bf459eeee00473c69f352fd4e61b70a4be9531a76b164d1e1fbc7373fe634033f19c519dc56098b77e536431d53a46bd91bde017887ed91f61a
+  data.tar.gz: 1fc747fda798976e4c13e4c0fd208a83253b61d8f1b473029e085308f7603f7d20e616f32c9b0e564952e6f48cf4e1eb10cc5570d8d6525c6c4a9728449e5b08

data/README.md

@@ -6,11 +6,11 @@
 [![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 w/ [OmniAI](https://github.com/ksylvest/omniai).
+`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 / deleting files and directories within a "root":
+Disk tools are focused on creating, updating, and deleting files and directories within a "root":
 
 ```ruby
 require "omniai/openai"
@@ -53,7 +53,7 @@ end
 
 ## Docker
 
-Disk tools are focused on running commands through Docker via compose:
+Docker tools are focused on running commands through Docker via Compose:
 
 ```ruby
 require "omniai/openai"
@@ -72,7 +72,7 @@ tools = [
 puts "Type 'exit' or 'quit' to leave."
 
 prompt = OmniAI::Chat::Prompt.build do |builder|
-  builder.system "Use tools to interact with docker."
+  builder.system "Use tools to interact with Docker."
 end
 
 loop do

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

@@ -7,9 +7,9 @@ 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]
 

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

@@ -4,13 +4,13 @@ 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`)"

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

@@ -7,7 +7,7 @@ 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`)"
 

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

@@ -11,7 +11,7 @@ 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'`)"

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

@@ -7,7 +7,7 @@ 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'`)"

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.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre