omniai-tools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 404c95beb54e2092a9a694887ba55a2e8ac8ec736bed56b755cfe34d0906cf9e
+  data.tar.gz: f07bf709204ea5a472733695e45870bbbf51b5f89a7d817d290e9e926cf4a57d
+SHA512:
+  metadata.gz: 206fda9b71017456d3d4f6d2c590849b93bf302c298916fe64fdd9552429357b35c86a01fde359f0ff7e63fc6202429e9bf16e4c4563a61b7ddc065a77c404e8
+  data.tar.gz: c7a122e9c86e418825285c4503236eb921570980eba9c8586c509243d2bb9ee7d3bb2d0da2187f331c8c53647153c2109b258d44ed52f12b1929e8cf08d8d93e

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "factory_bot"
+gem "irb"
+gem "rake"
+gem "rspec"
+gem "rspec_junit_formatter"
+gem "rubocop"
+gem "rubocop-basic"
+gem "rubocop-factory_bot"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"
+gem "yard"

data/README.md

@@ -0,0 +1,7 @@
+# OmniAI::Tools
+
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/omniai-tools/blob/main/LICENSE)
+[![RubyGems](https://img.shields.io/gem/v/omniai-tools)](https://rubygems.org/gems/omniai-tools)
+[![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)

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "omniai/tools"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   class ExampleTool < OmniAI::Tools::Disk::BaseTool
+      #     description "..."
+      #   end
+      class BaseTool < OmniAI::Tool
+        # @param root [Pathname] The root path for which a tool is able to operate within.
+        # @param logger [IO] An optional logger for debugging executed commands.
+        def initialize(root:, logger: Logger.new(IO::NULL))
+          super()
+          @root = Pathname(root)
+          @logger = logger
+        end
+
+      protected
+
+        # @param directory [Pathname]
+        # @param path [String]
+        #
+        # @raise [SecurityError]
+        #
+        # @return Pathname
+        def resolve!(path:)
+          @root.join(path).tap do |resolved|
+            relative = resolved.ascend.any? { |ancestor| ancestor.eql?(@root) }
+            raise SecurityError, "unknown path=#{resolved}" unless relative
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# 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 :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
+
+        # @param path [String]
+        #
+        # @return [String]
+        def execute(path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          FileUtils.mkdir_p(resolve!(path:))
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::DirectoryDeleteTool.new(root: "./project")
+      #   tool.execute(path: "./foo/bar")
+      class DirectoryDeleteTool < BaseTool
+        description "Deletes a directory."
+
+        parameter :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
+
+        # @param path [String]
+        #
+        # @return [String]
+        def execute(path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          FileUtils.rmdir(resolve!(path:))
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::FileCreateTool.new(root: "./project")
+      #   tool.execute(path: "./README.md")
+      class FileCreateTool < BaseTool
+        description "Creates a file."
+
+        parameter :path, :string, description: "a path to the file (e.g. `./README.md`)"
+
+        # @param path [String]
+        #
+        # @return [String]
+        def execute(path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          resolved = resolve!(path:)
+          FileUtils.touch(resolved) unless File.exist?(resolved)
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::FileDeleteTool.new(root: "./project")
+      #   tool.execute(path: "./README.md")
+      class FileDeleteTool < BaseTool
+        description "reads the contents of a file"
+
+        parameter :path, :string, description: "a path to the directory (e.g. `./foo/bar`)"
+
+        # @param path [String]
+        #
+        # @raise [SecurityError]
+        #
+        # @return [String]
+        def execute(path:)
+          @logger.info("#{self.class.name}#execute path=#{path.inspect}")
+
+          File.delete(resolve!(path:))
+        rescue SecurityError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::FileDeleteTool.new(root: "./project")
+      #   tool.execute(
+      #     old_path: "./README.txt",
+      #     new_path: "./README.md",
+      #   )
+      class FileMoveTool < BaseTool
+        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`)"
+
+        # @param old_path [String]
+        # @param new_path [String]
+        #
+        # @return [String]
+        def execute(old_path:, new_path:)
+          @logger.info("#{self.class.name}#execute old_path=#{old_path.inspect} new_path=#{new_path.inspect}")
+
+          FileUtils.mv(
+            resolve!(path: old_path),
+            resolve!(path: new_path)
+          )
+        rescue SecurityError => e
+          @logger.info("ERROR: #{e.message}")
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::FileReadTool.new(root: "./project")
+      #   tool.execute(path: "./README.md") # => "..."
+      class FileReadTool < BaseTool
+        description "reads the contents of a file"
+
+        parameter :path, :string, description: "a path (e.g. `./main.rb`)"
+
+        # @param path [String]
+        #
+        # @return [String]
+        def execute(path:)
+          @logger.info("#{self.class.name}#execute path=#{path}")
+          File.read(resolve!(path:))
+        rescue StandardError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::FileReadTool.new(root: "./project")
+      #   tool.execute(
+      #     old_text: 'puts "ABC"',
+      #     new_text: 'puts "DEF"',
+      #     path: "README.md"
+      #   )
+      class FileReplaceTool < BaseTool
+        description "replace 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`)"
+
+        # @param path [String]
+        # @param old_text [String]
+        # @param new_text [String]
+        def execute(old_text:, new_text:, path:)
+          @logger.info %(#{self.class.name}#execute old_text="#{old_text}" new_text="#{new_text}" path="#{path}")
+
+          resolved = resolve!(path:)
+          contents = File.read(resolved)
+          modified = contents.gsub(old_text, new_text)
+          File.write(resolved, modified)
+        rescue StandardError => e
+          @logger.error(e.message)
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #    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."
+
+        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'`)"
+
+        # @param path [String]
+        # @param text [String]
+        #
+        # @return [String]
+        def execute(path:, text:)
+          @logger.info("#{self.class.name}#execute path=#{path}")
+          File.write(resolve!(path:), text)
+        rescue StandardError => e
+          @logger.error("ERROR: #{e.message}")
+          raise e
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    module Disk
+      # @example
+      #   tool = OmniAI::Tools::Disk::SummaryTool.new(root: "./project")
+      #   tool.execute
+      class SummaryTool < BaseTool
+        description "Summarize the contents (files and directories) of the project."
+
+        # @return [String]
+        def execute
+          @logger.info("#{self.class.name}#execute")
+
+          Dir.chdir(@root) do
+            summary = Dir.glob("**/*").map { |path| summarize(path:) }.join("\n")
+            @logger.debug(summary)
+            summary
+          end
+        end
+
+      private
+
+        # @param path [String]
+        def summarize(path:)
+          if File.directory?(path)
+            "📁 ./#{path}/"
+          else
+            "📄 ./#{path} (#{File.size(path)} bytes)"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module OmniAI
+  module Tools
+    module Docker
+      # @example
+      #   class ExampleTool < OmniAI::Tools::Disk::BaseTool
+      #     description "..."
+      #   end
+      class BaseTool < OmniAI::Tool
+        # @example
+        #   raise CaptureError.new(text: "an unknown error occurred", status: Process::Status.new(0))
+        class CaptureError < StandardError
+          # !@attribute [rw] text
+          #   @return [String]
+          attr_accessor :text
+
+          # @!attribute [rw] status
+          #   @return [Process::Status]
+          attr_accessor :status
+
+          # @param text [String]
+          # @param status [Process::Status]
+          def initialize(text:, status:)
+            super("[STATUS=#{status.exitstatus}] #{text}")
+            @text = text
+            @status = status
+          end
+        end
+
+        # @param root [Pathname]
+        # @param logger [IO] optional
+        def initialize(root:, logger: Logger.new(IO::NULL))
+          super()
+          @root = root
+          @logger = logger
+        end
+
+      protected
+
+        # @raise [CaptureError]
+        #
+        # @return [String]
+        def capture!(...)
+          text, status = Open3.capture2e(...)
+
+          raise CaptureError.new(text:, status:) unless status.success?
+
+          text
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module OmniAI
+  module Tools
+    module Docker
+      # @example
+      #   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`)."
+
+        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`)")
+
+        # @param service [String]
+        # @param command [String]
+        # @param args [Array<String>]
+        #
+        # @return [String]
+        def execute(command:, service: "app", args: [])
+          @logger.info(%(#{self.class.name}#execute service="#{service}" command="#{command}" args=#{args.inspect}))
+
+          Dir.chdir(@root) do
+            capture!("docker", "compose", "run", "--build", "--rm", service, command, *args)
+          rescue CaptureError => e
+            @logger.info("ERROR: #{e.message}")
+            return "ERROR: #{e.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/omniai/tools/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAI
+  module Tools
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniai/tools.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "omniai"
+
+loader = Zeitwerk::Loader.for_gem
+loader.push_dir(__dir__, namespace: OmniAI)
+loader.setup
+
+module OmniAI
+  module Tools
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: omniai-tools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+bindir: exe
+cert_chain: []
+date: 2025-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: These examples can be used for inspiration or directly within an app.
+email:
+- kevin@ksylvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- lib/omniai/tools.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/file_create_tool.rb
+- lib/omniai/tools/disk/file_delete_tool.rb
+- lib/omniai/tools/disk/file_move_tool.rb
+- lib/omniai/tools/disk/file_read_tool.rb
+- lib/omniai/tools/disk/file_replace_tool.rb
+- lib/omniai/tools/disk/file_write_tool.rb
+- lib/omniai/tools/disk/summary_tool.rb
+- lib/omniai/tools/docker/base_tool.rb
+- lib/omniai/tools/docker/compose_run_tool.rb
+- lib/omniai/tools/version.rb
+homepage: https://github.com/ksylvest/omniai-tools
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ksylvest/omniai-tools
+  changelog_uri: https://github.com/ksylvest/omniai-tools/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A set of tools built for usage with OmniAI.
+test_files: []