autoflux 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10be8379032b489e881578406d74b7f9f0c80b480fc61b5ccf6c7e8e041f59ab
-  data.tar.gz: d1567e48c28a48cd432c6bb4aa5c8c1856e8b920c3c8768f5c0ac4764bdc8dcc
+  metadata.gz: 4057f638e916ef5cca2980912c4daf1b0928cc929766156f7859ae93d2a596f6
+  data.tar.gz: a71fc9aaa77da24cb1c4dd9ea7dcd46b7386d640aaef737eb143d960bd1183c7
 SHA512:
-  metadata.gz: acccc975d159aaf9d9262b2fa1cdc0a1cd2d8fc5a2bf3181121a721efe65d6731b733f7f588b0cfac30efe68d0979b14c54aca5b0bbcc0cb6a10bc8b0b38bfff
-  data.tar.gz: 5c99079282673226f90293ec9e0ec03ac65c1a658441bdf91511aadcc01ce2aa729d6accee8b7f864aa29b69e58b8eed9f4bc63ea6bc404e0048a799e0e4e1a5
+  metadata.gz: 59926823b4d02b924f919f63df286be8e912e3a13921e8033ba7db333d21ff95ad0f5e4be669f604bf1bfea6c9c3ec90f4c2844375ad768c05dd835b9c9df2c6
+  data.tar.gz: 5ab23c20f3a229f5cc864b4814a08d8a25d3e38de97ef04c41ba77470c97ca0a9b1b297caaf86f8b01a54ef67ae69524d6b2deef91b10eb397b935879dc322ca

data/LICENSE.txt

@@ -1,21 +1,201 @@
-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.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Qiu ZhengXian
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -27,12 +27,12 @@ Autoflux provides a default state machine for a chat workflow.
 ```mermaid
 stateDiagram-v2
     [*] --> Start
-    Start --> User
-    User --> Assistant
-    Assistant --> User
+    Start --> Command
+    Command --> Assistant
+    Assistant --> Command
     Assistant --> Tool
     Tool --> Assistant
-    User --> Stop
+    Command --> Stop
     Stop --> [*]
 ```
 
@@ -57,7 +57,7 @@ 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.
+The agent is an adapter to the LLM model. You can inherit the `Autoflux::Agent` class to implement your own agent.
 
 ```ruby
 # :nodoc:
@@ -99,7 +99,7 @@ The memory is chat history which keep in the workflow. You can decide to use it
 
 ### 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.
+The tool is a function that can be used in the agent's response. You can inherit the `Autoflux::Tool` class to implement your own tool.
 
 ```ruby
 # :nodoc:
@@ -128,17 +128,17 @@ 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.
+The IO is an adapter to the input and output. You can inherit the `Autoflux::IO` class to implement your own IO.
 
 ```ruby
 # :nodoc:
 class ConsoleIO < Autoflux::IO
-  def input
+  def read
     print 'User: '
     gets.chomp
   end
 
-  def output(message)
+  def write(message)
     puts "Assistant: #{message}"
   end
 end

data/Rakefile

@@ -9,4 +9,10 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+require "steep/rake_task"
+Steep::RakeTask.new do |t|
+  t.check.severity_level = :error
+  t.watch.verbose
+end
+
+task default: %i[spec rubocop steep]

data/Steepfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# D = Steep::Diagnostic
+#
+target :lib do
+  check "lib"
+  signature "sig"
+  ignore_signature "sig/test"
+
+  library "securerandom"
+  library "json"
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting (applies by default)
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end
+
+# target :test do
+#   unreferenced!                     # Skip type checking the `lib` code when types in `test` target is changed
+#   signature "sig/test"              # Put RBS files for tests under `sig/test`
+#   check "test"                      # Type check Ruby scripts under `test`
+#
+#   configure_code_diagnostics(D::Ruby.lenient)      # Weak type checking for test code
+#
+#   # library "pathname"              # Standard libraries
+# end

data/lib/autoflux/step/assistant.rb

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

data/lib/autoflux/step/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module Step
+    # The Step::Base is abstract class to represent the interface of the state
+    class Base
+      # @rbs workflow: Workflow
+      def call(**)
+        raise NotImplementedError
+      end
+
+      def name
+        self.class.name || "Step"
+      end
+    end
+  end
+end

data/lib/autoflux/step/command.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module Step
+    # The Command step is used to get the user input.
+    class Command < Base
+      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
+end

data/lib/autoflux/step/start.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module Step
+    # The Start step is used to start the workflow.
+    class Start < Base
+      def call(**) = Command.new
+    end
+  end
+end

data/lib/autoflux/step/stop.rb

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

data/lib/autoflux/step/tool.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Autoflux
+  module Step
+    # The Tool state is used to call the tools provided by the agent.
+    class Tool < Base
+      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) # steep:ignore
+      rescue JSON::ParserError
+        { status: "error", message: "Invalid arguments" }
+      end
+    end
+  end
+end

data/lib/autoflux/step.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Autoflux
+  # The Step means a state in the workflow
+  module Step
+    require "autoflux/step/base"
+    require "autoflux/step/start"
+    require "autoflux/step/stop"
+    require "autoflux/step/command"
+    require "autoflux/step/assistant"
+    require "autoflux/step/tool"
+  end
+end

data/lib/autoflux/version.rb

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

data/lib/autoflux/workflow.rb

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
+require "securerandom"
+
 module Autoflux
   # The workflow is a state machine to manage the flow of agentic AI.
   class Workflow
-    attr_reader :agent, :state, :memory, :io
+    class << self
+      # Generate a random UUID.
+      #
+      # @return [String]
+      def next_id
+        return SecureRandom.uuid_v7 if RUBY_VERSION >= "3.3" # steep:ignore
+
+        SecureRandom.uuid
+      end
+    end
+
+    attr_reader :id, :agent, :memory, :io
 
     # @rbs state: State
-    def initialize(agent:, io:, state: Start.new, memory: Memory.new)
+    def initialize(agent:, io:, id: nil, step: Step::Start.new, memory: Memory.new)
+      @id = id || Workflow.next_id
       @agent = agent
       @io = io
-      @state = state
+      @step = step
       @memory = memory
     end
 
@@ -18,7 +32,27 @@ module Autoflux
     # @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?
+      @step = step.call(workflow: self) while @step
+    end
+
+    # Stop the workflow.
+    def stop
+      @step = Step::Stop.new
+    end
+
+    # Get the current step. If the step is nil, return a Stop step.
+    def step
+      @step || Step::Stop.new
+    end
+
+    # Get the hash representation of the workflow.
+    #
+    # @return [Hash]
+    def to_h
+      {
+        id: id,
+        step: step.name
+      }
     end
   end
 end

data/lib/autoflux.rb

@@ -10,11 +10,6 @@ module Autoflux
   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/step"
   require_relative "autoflux/workflow"
 end

data/sig/autoflux/agent.rbs

@@ -0,0 +1,16 @@
+module Autoflux
+  # Agent implements the _Agent interface.
+  interface _Agent
+    def tool?: (String name) -> bool
+    def tool: (String name) -> _Tool?
+    def call: (memory: _Memory) -> untyped
+  end
+
+  # The Agent is a abstract class to represent the adapter of the Language Model.
+  class Agent
+    include _Agent
+
+    @_tools: Array[_Tool]
+    def initialize: (?tools: Array[_Tool]?) -> void
+  end
+end

data/sig/autoflux/io.rbs

@@ -0,0 +1,11 @@
+module Autoflux
+  interface _IO
+    def read: () -> String
+    def write: (String data) -> String
+  end
+
+  # The IO is abstract class to represent the interface of the IO
+  class IO
+    include _IO
+  end
+end

data/sig/autoflux/memory.rbs

@@ -0,0 +1,20 @@
+module Autoflux
+  interface _Memory
+    def data: () -> Array[untyped]
+    def push: (untyped data) -> untyped
+    def last: () -> untyped
+  end
+
+  # The Memory is a class to store the memory of the workflow.
+  class Memory
+    include _Memory
+
+    @data: Array[untyped]
+    @verbose: bool
+
+    attr_reader verbose: bool
+
+    # @rbs data: Array[Hash]
+    def initialize: (?data: Array[untyped], ?verbose: bool) -> void
+  end
+end

data/sig/autoflux/stdio.rbs

@@ -0,0 +1,21 @@
+module Autoflux
+  # The Stdio is a class to represent the standard input/output.
+  class Stdio < IO
+    @input: untyped
+
+    @output: untyped
+
+    @prompt: untyped
+
+    attr_accessor prompt: untyped
+
+    # @rbs input: IO
+    # @rbs output: IO
+    def initialize: (?input: untyped, ?output: untyped, ?prompt: untyped?) -> void
+
+    def read: () -> untyped
+
+    # @rbs data: String
+    def write: (untyped data) -> untyped
+  end
+end

data/sig/autoflux/step.rbs

@@ -0,0 +1,36 @@
+module Autoflux
+  interface _Step
+    def name: () -> String
+    def call: (workflow: Workflow) -> untyped
+  end
+
+  module Step
+    # The Step::Base is abstract class to represent the interface of the state
+    class Base
+      include Autoflux::_Step
+    end
+
+    # The Start step is used to start the workflow.
+    class Start < Base
+    end
+
+    # The Stop step is used to stop the workflow.
+    class Stop < Base
+    end
+
+    # The Assistant state is used to call the agent.
+    class Assistant < Base
+      OUTPUT_ROLE_NAME: "assistant"
+    end
+
+    # The Tool state is used to call the tools provided by the agent.
+    class Tool < Base
+      def run: (workflow: Workflow, tool: untyped) -> untyped
+    end
+
+    # The Command step is used to get the user input.
+    class Command < Base
+      EXIT_COMMAND: "exit"
+    end
+  end
+end

data/sig/autoflux/tool.rbs

@@ -0,0 +1,20 @@
+module Autoflux
+  interface _Tool
+    def name: () -> String
+    def description: () -> String
+    def parameters: () -> untyped
+
+    def call: (**untyped) -> untyped
+  end
+
+  # The Tool is a abstract class to represent the adapter of tools which can be used by the Language Model.
+  class Tool
+    include _Tool
+
+    @name: String
+    @description: String
+    @parameters: untyped
+
+    def initialize: (name: String, description: String, ?parameters: untyped?) -> void
+  end
+end

data/sig/autoflux/workflow.rbs

@@ -0,0 +1,39 @@
+module Autoflux
+  # The workflow is a state machine to manage the flow of agentic AI.
+  class Workflow
+    @id: String
+    @agent: _Agent
+    @io: _IO
+    @step: _Step
+    @memory: _Memory
+
+    # Generate a random UUID.
+    #
+    # @return [String]
+    def self.next_id: () -> String
+
+    attr_reader id: String
+    attr_reader agent: _Agent
+    attr_reader memory: _Memory
+    attr_reader io: _IO
+
+    # @rbs state: State
+    def initialize: (agent: _Agent, io: _IO, ?id: String?, ?step: _Step, ?memory: _Memory) -> void
+
+    # Run the workflow.
+    #
+    # @rbs system_prompt: String?
+    def run: (?system_prompt: String?) -> void
+
+    # Stop the workflow.
+    def stop: () -> void
+
+    # Get the current step. If the step is nil, return a Stop step.
+    def step: () -> _Step
+
+    # Get the hash representation of the workflow.
+    #
+    # @return [Hash]
+    def to_h: () -> { id: String, step: String }
+  end
+end

data/sig/autoflux.rbs

@@ -1,4 +1,6 @@
 module Autoflux
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoflux
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aotokitsuruya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies: []
 description: A lightweight AI agent framework for Ruby
 email:
@@ -24,24 +24,33 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - commitlint.config.js
 - lib/autoflux.rb
 - lib/autoflux/agent.rb
-- lib/autoflux/assistant.rb
 - lib/autoflux/io.rb
 - lib/autoflux/memory.rb
-- lib/autoflux/start.rb
-- lib/autoflux/state.rb
 - lib/autoflux/stdio.rb
-- lib/autoflux/stop.rb
+- lib/autoflux/step.rb
+- lib/autoflux/step/assistant.rb
+- lib/autoflux/step/base.rb
+- lib/autoflux/step/command.rb
+- lib/autoflux/step/start.rb
+- lib/autoflux/step/stop.rb
+- lib/autoflux/step/tool.rb
 - lib/autoflux/tool.rb
-- lib/autoflux/tools.rb
-- lib/autoflux/user.rb
 - lib/autoflux/version.rb
 - lib/autoflux/workflow.rb
 - package-lock.json
 - package.json
 - sig/autoflux.rbs
+- sig/autoflux/agent.rbs
+- sig/autoflux/io.rbs
+- sig/autoflux/memory.rbs
+- sig/autoflux/stdio.rbs
+- sig/autoflux/step.rbs
+- sig/autoflux/tool.rbs
+- sig/autoflux/workflow.rbs
 homepage: https://github.com/elct9620/autoflux
 licenses:
 - Apache-2.0
@@ -64,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A lightweight AI agent framework

data/lib/autoflux/assistant.rb

@@ -1,18 +0,0 @@
-# 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/start.rb

@@ -1,8 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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/stop.rb

@@ -1,8 +0,0 @@
-# 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/tools.rb

@@ -1,30 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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