autoflux 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10be8379032b489e881578406d74b7f9f0c80b480fc61b5ccf6c7e8e041f59ab
+  data.tar.gz: d1567e48c28a48cd432c6bb4aa5c8c1856e8b920c3c8768f5c0ac4764bdc8dcc
+SHA512:
+  metadata.gz: acccc975d159aaf9d9262b2fa1cdc0a1cd2d8fc5a2bf3181121a721efe65d6731b733f7f588b0cfac30efe68d0979b14c54aca5b0bbcc0cb6a10bc8b0b38bfff
+  data.tar.gz: 5c99079282673226f90293ec9e0ec03ac65c1a658441bdf91511aadcc01ce2aa729d6accee8b7f864aa29b69e58b8eed9f4bc63ea6bc404e0048a799e0e4e1a5

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --verbose --edit $1

data/.husky/pre-commit

@@ -0,0 +1 @@
+bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aotokitsuruya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,170 @@
+Autoflux
+===
+
+A lightweight AI agent framework
+
+> [!WARNING]
+> To support common agentic AI workflow, the API will be changed at any time until the design is completed.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add autoflux
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install autoflux
+```
+
+## Usage
+
+Autoflux provides a default state machine for a chat workflow.
+
+```mermaid
+stateDiagram-v2
+    [*] --> Start
+    Start --> User
+    User --> Assistant
+    Assistant --> User
+    Assistant --> Tool
+    Tool --> Assistant
+    User --> Stop
+    Stop --> [*]
+```
+
+To start a new workflow use `Autoflux::Workflow`:
+
+```ruby
+workflow = Autoflux::Workflow.new(
+    agent: agent,
+    io: io,
+)
+
+workflow.run
+```
+
+You can give a system prompt when running the workflow:
+
+```ruby
+workflow.run(system_prompt: 'Help user to solve the problem')
+```
+
+When receive "exit" from the user, the workflow transition to the stop state.
+
+### Agent
+
+The agent is an adapter to the LLM model. You can ihnerit the `Autoflux::Agent` class to implement your own agent.
+
+```ruby
+# :nodoc:
+class OpenAIAgent < Autoflux::Agent
+  attr_reader :client, :model
+
+  def initialize(client:, tools: [], model: 'gpt-4o-mini')
+    super(tools: tools)
+    @client = client
+    @model = model
+  end
+
+  def call(memory:)
+    client.chat(
+      parameters: {
+        model: model,
+        messages: memory.data,
+        tools: tools
+      }
+    ).dig('choices', 0, 'message')
+  end
+
+  def tools
+    @tools ||= @_tools.map do |tool|
+      {
+        type: :function,
+        function: {
+          name: tool.name,
+          description: tool.description,
+          parameters: tool.parameters
+        }
+      }
+    end
+  end
+end
+```
+
+The memory is chat history which keep in the workflow. You can decide to use it or not.
+
+### Tool
+
+The tool is a function that can be used in the agent's response. You can ihnerit the `Autoflux::Tool` class to implement your own tool.
+
+```ruby
+# :nodoc:
+class AddToCartTool < Autoflux::Tool
+  def initialize # rubocop:disable Metrics/MethodLength
+    super(
+      name: 'add_to_cart',
+      description: 'Add the product to the cart',
+      parameters: {
+        type: 'object',
+        properties: {
+          name: { type: 'string', description: 'The name of the product' },
+          quantity: { type: 'number', description: 'The quantity of the product' }
+        }
+      }
+    )
+  end
+
+  def call(name:, quantity:, **)
+    { success: true, content: "Added #{quantity} #{name} to the cart" }
+  end
+end
+```
+
+The tool is require the name and description. The parameters is optional.
+
+### IO
+
+The IO is an adapter to the input and output. You can ihnerit the `Autoflux::IO` class to implement your own IO.
+
+```ruby
+# :nodoc:
+class ConsoleIO < Autoflux::IO
+  def input
+    print 'User: '
+    gets.chomp
+  end
+
+  def output(message)
+    puts "Assistant: #{message}"
+  end
+end
+```
+
+The default `Autoflux::Stdio` implement the minimal Standard I/O support.
+
+```ruby
+workflow = Autoflux::Workflow.new(
+    agent: agent,
+    io: Autoflux::Stdio.new(prompt: '> ')
+)
+
+workflow.run
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/autoflux.
+
+## License
+
+The gem is available as open source under the terms of the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/commitlint.config.js

@@ -0,0 +1 @@
+export default { extends: ['@commitlint/config-conventional'] };

data/lib/autoflux/agent.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Agent is a abstract class to represent the adapter of the Language Model.
+  class Agent
+    # @rbs tools: Array<Tool>
+    def initialize(tools: [])
+      @_tools = tools
+    end
+
+    # @rbs name: String
+    def tool?(name)
+      @_tools.any? { |tool| tool.name == name }
+    end
+
+    # @rbs name: String
+    def tool(name)
+      @_tools.find { |tool| tool.name == name }
+    end
+
+    # @rbs memory: Memory?
+    def call(**)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/autoflux/assistant.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Assistant state is used to call the agent.
+  class Assistant
+    OUTPUT_ROLE_NAME = "assistant"
+
+    def call(workflow:)
+      res = workflow.agent.call(memory: workflow.memory)
+      workflow.memory.push(res)
+      return Tools.new if res["tool_calls"]&.any?
+
+      workflow.io.write(res["content"]) if res["role"] == OUTPUT_ROLE_NAME
+
+      User.new
+    end
+  end
+end

data/lib/autoflux/io.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The IO is abstract class to represent the interface of the IO
+  class IO
+    def read
+      raise NotImplementedError
+    end
+
+    # @rbs data: String
+    def write(_)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/autoflux/memory.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Memory is a class to store the memory of the workflow.
+  class Memory
+    attr_reader :data, :verbose
+
+    # @rbs data: Array[Hash]
+    def initialize(data: [], verbose: false)
+      @data = data
+      @verbose = verbose
+      freeze
+    end
+
+    # Push the data to the memory.
+    #
+    # @rbs data: Hash
+    def push(data)
+      puts JSON.pretty_generate(data) if verbose
+      @data.push(data)
+    end
+
+    # Get the last data from the memory.
+    def last
+      @data.last
+    end
+  end
+end

data/lib/autoflux/start.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Start state is used to start the workflow.
+  class Start < State
+    def call(**) = User.new
+  end
+end

data/lib/autoflux/state.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The State is abstract class to represent the interface of the state
+  class State
+    # @rbs workflow: Workflow
+    def call(**)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/autoflux/stdio.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Stdio is a class to represent the standard input/output.
+  class Stdio < IO
+    attr_accessor :prompt
+
+    # @rbs input: IO
+    # @rbs output: IO
+    def initialize(input: $stdin, output: $stdout, prompt: nil)
+      super()
+
+      @input = input
+      @output = output
+      @prompt = prompt
+      freeze
+    end
+
+    def read
+      print prompt if prompt
+      @input.gets.chomp
+    end
+
+    # @rbs data: String
+    def write(data)
+      @output.puts(data)
+    end
+  end
+end

data/lib/autoflux/stop.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Stop state is used to stop the workflow.
+  class Stop < State
+    def call(**) = nil
+  end
+end

data/lib/autoflux/tool.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Tool is a abstract class to represent the adapter of tools which can be used by the Language Model.
+  class Tool
+    attr_reader :name, :description, :parameters
+
+    def initialize(name:, description:, parameters: nil)
+      @name = name
+      @description = description
+      @parameters = parameters
+      freeze
+    end
+
+    def call(**)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/autoflux/tools.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Tools state is used to call the tools provided by the agent.
+  class Tools
+    def call(workflow:)
+      workflow.memory.last["tool_calls"]&.each do |tool|
+        workflow.memory.push(
+          role: :tool,
+          content: run(workflow: workflow, tool: tool).to_json,
+          tool_call_id: tool["id"]
+        )
+      end
+
+      Assistant.new
+    end
+
+    protected
+
+    def run(workflow:, tool:)
+      name = tool.dig("function", "name")
+      params = JSON.parse(tool.dig("function", "arguments"), symbolize_names: true)
+      return { status: "error", message: "Tool not found" } unless workflow.agent.tool?(name)
+
+      workflow.agent.tool(name).call(**params)
+    rescue JSON::ParserError
+      { status: "error", message: "Invalid arguments" }
+    end
+  end
+end

data/lib/autoflux/user.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The User state is used to get the user input.
+  class User
+    EXIT_COMMAND = "exit"
+
+    def call(workflow:)
+      input = workflow.io.read
+      return Stop.new if input == EXIT_COMMAND
+
+      workflow.memory.push(role: :user, content: input)
+
+      Assistant.new
+    end
+  end
+end

data/lib/autoflux/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Autoflux
+  VERSION = "0.1.0"
+end

data/lib/autoflux/workflow.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The workflow is a state machine to manage the flow of agentic AI.
+  class Workflow
+    attr_reader :agent, :state, :memory, :io
+
+    # @rbs state: State
+    def initialize(agent:, io:, state: Start.new, memory: Memory.new)
+      @agent = agent
+      @io = io
+      @state = state
+      @memory = memory
+    end
+
+    # Run the workflow.
+    #
+    # @rbs system_prompt: String?
+    def run(system_prompt: nil)
+      memory.push(role: :system, content: system_prompt) unless system_prompt.nil?
+      @state = @state.call(workflow: self) until @state.nil?
+    end
+  end
+end

data/lib/autoflux.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "autoflux/version"
+
+# The Autoflux is a lightweight AI agent framework.
+module Autoflux
+  class Error < StandardError; end
+
+  require_relative "autoflux/tool"
+  require_relative "autoflux/agent"
+  require_relative "autoflux/io"
+  require_relative "autoflux/memory"
+  require_relative "autoflux/state"
+  require_relative "autoflux/start"
+  require_relative "autoflux/user"
+  require_relative "autoflux/assistant"
+  require_relative "autoflux/tools"
+  require_relative "autoflux/stop"
+  require_relative "autoflux/workflow"
+end