omniai-tools 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc1dae9ab7fe238fadd4c48d660f342e851b1803e3e33e22c487ceabd3bf32b
-  data.tar.gz: cf37310371a1711adaedea7609ce340552c7858faab4d9b60c6d26919864490a
+  metadata.gz: f361e26584723aa8d30ba41edaefafb44a7e08c5c6345656dbf25e37c965448d
+  data.tar.gz: c718feeb39dfdd1c2c5ff9a2976ece26eec48aae12f52405724fc21209101d32
 SHA512:
-  metadata.gz: 766b80d9ab2b3bf459eeee00473c69f352fd4e61b70a4be9531a76b164d1e1fbc7373fe634033f19c519dc56098b77e536431d53a46bd91bde017887ed91f61a
-  data.tar.gz: 1fc747fda798976e4c13e4c0fd208a83253b61d8f1b473029e085308f7603f7d20e616f32c9b0e564952e6f48cf4e1eb10cc5570d8d6525c6c4a9728449e5b08
+  metadata.gz: fa14b3333edc0b235e046d9f408f75f201ea37be76435d897873fb7585999cd0aeac3d36c86c16e72a772ab6a28f48dd40560074767720736583de79a80d8847
+  data.tar.gz: 6ec511fc27bae83abdf0d827572ad2784419039b0d37d128d5670b19d58645a8e6efd82bfb7132397473181b56897f966314396a76172aaec33883826ff14f12

data/Gemfile

@@ -16,4 +16,5 @@ gem "rubocop-factory_bot"
 gem "rubocop-rake"
 gem "rubocop-rspec"
 gem "simplecov"
+gem "sqlite3"
 gem "yard"

data/README.md

@@ -8,6 +8,54 @@
 
 `OmniAI::Tools` is a library of pre-built tools to simplify integrating common tasks with [OmniAI](https://github.com/ksylvest/omniai).
 
+## Database
+
+Database tools are focused on running SQL statements:
+
+```ruby
+require "omniai/openai"
+require "omniai/tools"
+
+require "sqlite3"
+
+db = SQLite3::Database.new(":memory:")
+
+client = OmniAI::OpenAI::Client.new
+logger = Logger.new($stdout)
+
+tools = [
+  OmniAI::Tools::Database::SqliteTool.new(logger:, db:),
+]
+
+puts "Type 'exit' or 'quit' to leave."
+
+prompt = OmniAI::Chat::Prompt.build do |builder|
+  builder.system "Use tools to manage a database 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
+```
+
+```
+Type 'exit' or 'quit' to leave.
+# Generate tables for artists, albums, songs, bands, members and populate it with data surrounding the Beatles.
+
+CREATE TABLE artists (id INTEGER PRIMARY KEY, name TEXT NOT NULL)
+CREATE TABLE bands (id INTEGER PRIMARY KEY, name TEXT NOT NULL)
+CREATE TABLE members (id INTEGER PRIMARY KEY, artist_id INTEGER, band_id INTEGER, FOREIGN KEY(artist_id) REFERENCES artists(id), FOREIGNKEY(band_id) REFERENCES bands(id))"
+CREATE TABLE albums (id INTEGER PRIMARY KEY, title TEXT NOT NULL, band_id INTEGER, FOREIGN KEY(band_id) REFERENCES bands(id))
+CREATE TABLE songs (id INTEGER PRIMARY KEY, title TEXT NOT NULL, album_id INTEGER, FOREIGN KEY(album_id) REFERENCES albums(id))
+...
+```
+
 ## Disk
 
 Disk tools are focused on creating, updating, and deleting files and directories within a "root":

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Database
+      # @example
+      #   tool = OmniAI::Tools::Database::SqliteTool.new
+      #   tool.execute(path: "./foo/bar")
+      class BaseTool < OmniAI::Tool
+        # @param logger [IO] An optional logger for debugging executed commands.
+        def initialize(logger: Logger.new(IO::NULL))
+          super()
+          @logger = logger
+        end
+
+        # @example
+        #   tool = OmniAI::Tools::Database::BaseTool.new
+        #   tool.execute(statements: ["SELECT * FROM people"])
+        #
+        # @param statements [Array<String>]
+        #
+        # @return [Array<Hash>]
+        def execute(statements:)
+          [].tap do |executions|
+            statements.map do |statement|
+              execution = perform(statement:)
+              executions << execution
+              break unless execution[:status].eql?(:ok)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/database/sqlite_tool.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+
+module OmniAI
+  module Tools
+    module Database
+      # @example
+      #   tool = OmniAI::Tools::Database::SqliteTool.new
+      #   tool.execute(path: "./foo/bar")
+      class SqliteTool < BaseTool
+        description <<~TEXT
+          Executes SQL commands (INSERT / UPDATE / SELECT / etc) on a database.
+
+          Example:
+
+          STATEMENTS:
+
+              [
+                'CREATE TABLE people (id INTEGER PRIMARY KEY, name TEXT NOT NULL)',
+                'INSERT INTO people (name) VALUES ('John')',
+                'INSERT INTO people (name) VALUES ('Paul')',
+                'SELECT * FROM people',
+                'DROP TABLE people'
+              ]
+
+          RESULT:
+
+              [
+                {
+                  "status": "OK",
+                  "statement": "CREATE TABLE people (id INTEGER PRIMARY KEY, name TEXT NOT NULL)",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "INSERT INTO people (name) VALUES ('John')"
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "INSERT INTO people (name) VALUES ('Paul')",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "SELECT * FROM people",
+                  "result": "..."
+                },
+                {
+                  "status": "OK",
+                  "statement": "DROP TABLE people",
+                  "result": "..."
+                }
+              ]
+        TEXT
+
+        parameter(
+          :statements,
+          :array,
+          description: "A list of SQL statements to run sequentially.",
+          items: OmniAI::Schema.string(description: 'A SQL statement to run (e.g. "SELECT * FROM ...").')
+        )
+
+        required %i[statements]
+
+        # @param logger [IO] An optional logger for debugging executed commands.
+        # @param db [SQLite3::Database] A sqlite database.
+        def initialize(db:, logger: Logger.new(IO::NULL))
+          super(logger:)
+          @db = db
+        end
+
+        # @example
+        #   tool = OmniAI::Tools::Database::BaseTool.new
+        #   tool.execute(statements: ["SELECT * FROM people"])
+        #
+        # @param statements [Array<String>]
+        #
+        # @return [Array<Hash>]
+        def execute(statements:)
+          [].tap do |executions|
+            statements.map do |statement|
+              execution = perform(statement:)
+              executions << execution
+              break unless execution[:status].eql?(:ok)
+            end
+          end
+        end
+
+      protected
+
+        # @param statement [String]
+        #
+        # @return [Hash]
+        def perform(statement:)
+          @logger.info(%(#{self.class.name}#perform statement=#{statement.inspect}))
+
+          result = @db.execute2(statement)
+
+          { status: :ok, statement:, result: }
+        rescue ::SQLite3::Exception => e
+          @logger.warn("ERROR: #{e.message}")
+
+          { status: :error, statement:, result: e.message }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::DirectoryCreateTool.new(root: "./project")
+      #   tool.execute(path: "./foo/bar")
+      class DirectoryCreateTool < BaseTool
+        description "Creates a directory."
+
+        parameter :old_path, :string, description: "a path (e.g. `./old`)"
+        parameter :new_path, :string, description: "a path (e.g. `./new`)"
+
+        required %i[old_path new_path]
+
+        # @param old_path [String]
+        # @param new_path [String]
+        #
+        # @return [String]
+        def execute(old_path:, new_path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          FileUtils.mv(old_path, new_path)
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -14,7 +14,7 @@ module OmniAI
         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`).")
+          items: OmniAI::Schema.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.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: omniai-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 bindir: exe
 cert_chain: []
-date: 2025-04-23 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniai
@@ -49,9 +49,12 @@ files:
 - bin/console
 - bin/setup
 - lib/omniai/tools.rb
+- lib/omniai/tools/database/base_tool.rb
+- lib/omniai/tools/database/sqlite_tool.rb
 - lib/omniai/tools/disk/base_tool.rb
 - lib/omniai/tools/disk/directory_create_tool.rb
 - lib/omniai/tools/disk/directory_delete_tool.rb
+- lib/omniai/tools/disk/directory_move_tool.rb
 - lib/omniai/tools/disk/file_create_tool.rb
 - lib/omniai/tools/disk/file_delete_tool.rb
 - lib/omniai/tools/disk/file_move_tool.rb