ad-agent_architecture 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5f327df1d3c95d9adf30cbbe9d973b33457737096d21c607fbe080caa9d839
-  data.tar.gz: 948a4cbd3540dc300eedb249c96b13e1963058abbd4f2c205ea23ce55d446431
+  metadata.gz: cbe6603e537c91457b8d7a3694ecaa23f77eec779bc43ae46a175f37c51e957b
+  data.tar.gz: a65c74eae0fc6fdd21296f5da8b6b03d1ef46f6a6dd407d1b6deb38577dbf116
 SHA512:
-  metadata.gz: 6b7f671d1ad1c28534f6e35f0d141fdb05c8fe0c28192e12087d10fbacb67265e451d17a91df3194e3495d8fec98881ff31a4ec7000db10f13886bc9c0de5785
-  data.tar.gz: 07de02cccb8f30f128f8e81663eeba0e4e4dc190394c030675a8d574259e5c50d85bb8d4643de1c94db197b7261e2f7bb22b3ed2708eafdb6ac7c07802341258
+  metadata.gz: 9e9c114cd087a31e91352a3c9165cbad5b3e11b8668a77c37bd3226503e4746e2e6cdd53fb30b9c0b3a2bba84b4b050b32bce525b9b1d4e79ce215e9a7355f33
+  data.tar.gz: c0473487b838ebc28e5a59ef16b9b9d77e3a4bb3ba210f1ff771a1747053736500747dd06542c482b5326a5cd97b8e1d9058a0697e02bae9b9f1dbc76e343a15

data/.rubocop.yml

@@ -93,9 +93,6 @@ Style/AccessorGrouping:
 Metrics/AbcSize:
   Exclude:
     - "lib/ad/agent_architecture/**/*"
-Metrics/NoExpectationExample:
-  Exclude:
-    - "spec/ad/agent_architecture/dsl/*"
 
 Layout/SpaceBeforeComma:
   Enabled: false
@@ -112,18 +109,19 @@ RSpec/SpecFilePathSuffix:
   Enabled: true
 
 RSpec/NamedSubject:
-  Exclude:
-    - "**/spec/**/*"
+  Enabled: false
 
 RSpec/ExampleLength:
-  Exclude:
-    - "**/spec/**/*"
+  Enabled: false
 
 RSpec/MultipleExpectations:
   Max: 3
   Exclude:
     - "spec/ad/agent_architecture/dsl/actions/save_database_spec.rb"
 
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
 Metrics/CyclomaticComplexity:
   Exclude:
     - "lib/ad/agent_architecture/dsl/actions/save_database.rb"

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [0.0.11](https://github.com/appydave/ad-agent_architecture/compare/v0.0.10...v0.0.11) (2024-06-29)
+
+
+### Bug Fixes
+
+* improve reports ([62aac63](https://github.com/appydave/ad-agent_architecture/commit/62aac63af8b48b30514f21b940005e899538307f))
+
+## [0.0.10](https://github.com/appydave/ad-agent_architecture/compare/v0.0.9...v0.0.10) (2024-06-29)
+
+
+### Bug Fixes
+
+* refactor DSL to use component DSLs ([597050a](https://github.com/appydave/ad-agent_architecture/commit/597050ad727f1aaf8eb3e6589cf1c618f41499e7))
+
 ## [0.0.9](https://github.com/appydave/ad-agent_architecture/compare/v0.0.8...v0.0.9) (2024-06-29)
 
 

data/Guardfile

@@ -28,9 +28,9 @@ group :green_pass_then_cop, halt_on_fail: true do
     watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
   end
 
-  guard :shell do
-    watch(%r{^spec/usecases/.+\.rbx$}) do |m|
-      `ruby -r ./spec/usecases/dsl_initialize.rb #{m[0]}`
-    end
-  end
+  # guard :shell do
+  #   watch(%r{^spec/usecases/.+\.rbx$}) do |m|
+  #     `ruby -r ./spec/usecases/dsl_initialize.rb #{m[0]}`
+  #   end
+  # end
 end

data/lib/ad/agent_architecture/dsl/agent_dsl.rb

@@ -17,6 +17,10 @@ module Ad
           @workflow = WorkflowDsl.new(name)
         end
 
+        def settings(&block)
+          @workflow.settings(&block)
+        end
+
         def attributes(&block)
           @workflow.attributes(&block)
         end
@@ -25,8 +29,8 @@ module Ad
           @workflow.prompts(&block)
         end
 
-        def section(name:, &block)
-          @workflow.section(name: name, &block)
+        def section(name, &block)
+          @workflow.section(name, &block)
         end
 
         def save

data/lib/ad/agent_architecture/dsl/attribute_dsl.rb

@@ -4,13 +4,9 @@ module Ad
   module AgentArchitecture
     module Dsl
       # This class is responsible for defining the attributes of a workflow
-      class AttributeDsl
-        def initialize(attributes)
-          @attributes = attributes
-        end
-
+      class AttributeDsl < ChildDsl
         def attribute(name, type:, is_array: false)
-          @attributes[name] = { name: name, type: type, is_array: is_array }
+          workflow[:attributes][name] = { name: name, type: type, is_array: is_array }
         end
       end
     end

data/lib/ad/agent_architecture/dsl/child_dsl.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Ad
+  module AgentArchitecture
+    module Dsl
+      # This is the base class for all child DSLs
+      class ChildDsl
+        attr_reader :workflow
+
+        def initialize(workflow)
+          @workflow = workflow
+        end
+      end
+    end
+  end
+end

data/lib/ad/agent_architecture/dsl/prompt_dsl.rb

@@ -4,13 +4,17 @@ module Ad
   module AgentArchitecture
     module Dsl
       # This class is responsible for defining the prompts of a workflow
-      class PromptDsl
-        def initialize(prompts)
-          @prompts = prompts
+      class PromptDsl < ChildDsl
+        def prompt(name, path: nil, content: nil)
+          workflow[:prompts][name] = { name: name, content: content }
         end
 
-        def prompt(name, path: nil, content: nil)
-          @prompts[name] = { name: name, path: path, content: content }
+        def prompt_file(file)
+          prompt_path = workflow[:settings][:prompt_path]
+          raise 'Prompt path not defined in settings' unless prompt_path
+
+          full_path = File.join(prompt_path, file)
+          File.read(full_path)
         end
       end
     end

data/lib/ad/agent_architecture/dsl/section_dsl.rb

@@ -4,16 +4,17 @@ module Ad
   module AgentArchitecture
     module Dsl
       # This class is responsible for creating a section in the workflow
-      class SectionDsl
-        def initialize(name, order, sections)
+      class SectionDsl < ChildDsl
+        def initialize(workflow, name, order)
+          super(workflow)
+
           @section = { name: name, order: order, steps: [] }
-          @sections = sections
+          @workflow[:sections] << @section
           @current_step_order = 1
-          @sections << @section
         end
 
         def step(name:, &block)
-          StepDsl.new(name, @current_step_order, @section[:steps]).instance_eval(&block)
+          StepDsl.new(workflow, @section, name, @current_step_order).instance_eval(&block)
           @current_step_order += 1
         end
       end

data/lib/ad/agent_architecture/dsl/settings_dsl.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ad
+  module AgentArchitecture
+    module Dsl
+      # This class is responsible for defining the settings of a workflow
+      class SettingsDsl < ChildDsl
+        def method_missing(name, *args, &block)
+          if args.length == 1 && block.nil?
+            workflow[:settings][name] = args.first
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(_name, _include_private = false)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/ad/agent_architecture/dsl/step_dsl.rb

@@ -5,10 +5,16 @@ module Ad
     module Dsl
       # This class is responsible for defining the steps of a section
       class StepDsl
-        def initialize(name, order, steps)
-          @step = { name: name, order: order, input_attributes: [], output_attributes: [], prompt: '' }
-          @steps = steps
-          @steps << @step
+        def initialize(_workflow, section, name, order)
+          @step = {
+            name: name,
+            order: order,
+            prompt: '',
+            input_attributes: [],
+            output_attributes: []
+          }
+
+          section[:steps] << @step
         end
 
         def input(attr_name, **_opts)

data/lib/ad/agent_architecture/dsl/workflow_dsl.rb

@@ -8,24 +8,33 @@ module Ad
         attr_reader :workflow
 
         def initialize(name)
-          @workflow = { name: name, sections: [], attributes: {}, prompts: {} }
+          @workflow = { name: name, sections: [], attributes: {}, prompts: {}, settings: {} }
           @current_section_order = 1
         end
 
+        def settings(&block)
+          dsl = SettingsDsl.new(@workflow)
+          dsl.instance_eval(&block) if block_given?
+          dsl
+        end
+
         def attributes(&block)
-          dsl = AttributeDsl.new(@workflow[:attributes])
+          dsl = AttributeDsl.new(@workflow)
           dsl.instance_eval(&block) if block_given?
+          dsl
         end
 
         def prompts(&block)
-          dsl = PromptDsl.new(@workflow[:prompts])
+          dsl = PromptDsl.new(@workflow)
           dsl.instance_eval(&block) if block_given?
+          dsl
         end
 
-        def section(name:, &block)
-          dsl = SectionDsl.new(name, @current_section_order, @workflow[:sections])
-          dsl.instance_eval(&block) if block_given?
+        def section(name, &block)
+          dsl = SectionDsl.new(@workflow, name, @current_section_order)
           @current_section_order += 1
+          dsl.instance_eval(&block) if block_given?
+          dsl
         end
       end
     end

data/lib/ad/agent_architecture/report/workflow_detail_report.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'k_log'
-
 module Ad
   module AgentArchitecture
     module Report
@@ -12,17 +10,19 @@ module Ad
         def print(workflow)
           log.section_heading 'Workflow Details Report'
           log.kv 'Name', workflow.name
-          log.kv 'Description', workflow.description
+          # log.kv 'Description', workflow.description
 
           workflow.sections.each do |section|
             log.section_heading "Section: #{section.name}"
-            log.kv 'Order', section.order
+            # log.kv 'Order', section.order
             section.steps.each do |step|
               log.section_heading "Step: #{step.name}"
-              log.kv 'Order', step.order
-              log.kv 'Prompt', step.prompt
+              # log.kv 'Order', step.order
+              # log.kv 'Prompt', step.prompt
+              # puts step.input_attributes.first
+              # An ERROR here means you have not configured an attribute name
               log.kv 'Input Attributes', step.input_attributes.map { |ia| ia.attribute.name }.join(', ')
-              log.kv 'Output Attributes', step.output_attributes.map { |oa| oa.attribute.name }.join(', ')
+              log.kv 'Output Attributes', step.output_attributes.map { |oa| oa.attribute&.name }.join(', ')
             end
           end
         end

data/lib/ad/agent_architecture/version.rb

@@ -2,6 +2,6 @@
 
 module Ad
   module AgentArchitecture
-    VERSION = '0.0.10'
+    VERSION = '0.0.12'
   end
 end

data/lib/ad/agent_architecture.rb

@@ -13,27 +13,39 @@ Ad::AgentArchitecture::Database::CreateSchema.new(DB).execute
 
 require 'ad/agent_architecture/database/models'
 require 'ad/agent_architecture/database/sql_query'
+require 'ad/agent_architecture/dsl/child_dsl'
 require 'ad/agent_architecture/dsl/attribute_dsl'
 require 'ad/agent_architecture/dsl/prompt_dsl'
 require 'ad/agent_architecture/dsl/section_dsl'
 require 'ad/agent_architecture/dsl/step_dsl'
+require 'ad/agent_architecture/dsl/settings_dsl'
 require 'ad/agent_architecture/dsl/workflow_dsl'
 require 'ad/agent_architecture/dsl/agent_dsl'
 require 'ad/agent_architecture/dsl/actions/save_database'
 require 'ad/agent_architecture/dsl/actions/save_json'
 require 'ad/agent_architecture/dsl/actions/save_yaml'
-# require 'ad/agent_architecture/report/workflow_detail_report'
-# require 'ad/agent_architecture/report/workflow_list_report'
+require 'ad/agent_architecture/report/workflow_detail_report'
+require 'ad/agent_architecture/report/workflow_list_report'
 
-# Alias'
-# AgentWorkflow = Ad::AgentArchitecture::Dsl::AgentWorkflowDsl
+# AgentDsl Alias
+Agent = Ad::AgentArchitecture::Dsl::AgentDsl
 
 module Ad
+  # Module for the Agent Architecture gem
   module AgentArchitecture
     # raise Ad::AgentArchitecture::Error, 'Sample message'
     Error = Class.new(StandardError)
 
-    # Your code goes here...
+    # Define the root path of the gem
+    ROOT_PATH = Pathname.new(File.expand_path('../..', __dir__))
+
+    def self.gem_root
+      ROOT_PATH
+    end
+
+    def self.gem_relative_file(*args)
+      File.join(ROOT_PATH, *args)
+    end
   end
 end
 

data/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "ad-agent_architecture",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "ad-agent_architecture",
-      "version": "0.0.10",
+      "version": "0.0.12",
       "devDependencies": {
         "@klueless-js/semantic-release-rubygem": "github:klueless-js/semantic-release-rubygem",
         "@semantic-release/changelog": "^6.0.3",

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ad-agent_architecture",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "Architecture/Schema for AI Agents",
   "scripts": {
     "release": "semantic-release"

data/workflow.json

@@ -1,78 +1,122 @@
 {
-  "name": "YouTube Title Creator",
+  "name": "YouTube Transcript to Medium Article",
   "sections": [
     {
-      "name": "Research",
+      "name": "Analysis",
       "order": 1,
       "steps": [
         {
-          "name": "Starting Context",
+          "name": "Generate Outline",
           "order": 1,
           "input_attributes": [
-
+            "transcript"
           ],
           "output_attributes": [
-
+            "outline"
           ],
-          "prompt": "best_practice"
+          "prompt": "Analyze [transcript] and generate a preliminary outline for a blog post."
         },
         {
-          "name": "Basic titles",
+          "name": "Write First Draft",
           "order": 2,
           "input_attributes": [
-            "basic_title",
-            "basic_keyword",
-            "basic_transcript"
+            "outline"
           ],
           "output_attributes": [
-            "potential_titles"
+            "first_draft"
           ],
-          "prompt": "Keyword: [start_keyword]\nTitle: [start_title]\n\nTranscript:\n\n[start_transcript]\n"
+          "prompt": "Write a blog post based on [outline]."
         },
         {
-          "name": "Working Title",
+          "name": "Generate Intros",
           "order": 3,
           "input_attributes": [
-            "potential_titles"
+            "first_draft"
           ],
           "output_attributes": [
-            "working_title"
-          ]
+            "intro_variations"
+          ],
+          "prompt": "Create 5 introduction variations for [first_draft]."
+        },
+        {
+          "name": "Update Draft with Intro",
+          "order": 4,
+          "input_attributes": [
+            "first_draft",
+            "intro_variation"
+          ],
+          "output_attributes": [
+            "second_draft"
+          ],
+          "prompt": "Update [first_draft] with a better intro [intro_variation]."
+        },
+        {
+          "name": "Analyse Intro",
+          "order": 5,
+          "input_attributes": [
+            "second_draft"
+          ],
+          "output_attributes": [
+            "intro_analysis"
+          ],
+          "prompt": "Analyze the article [second_draft] introduction"
+        },
+        {
+          "name": "Combine Intro Analysis",
+          "order": 6,
+          "input_attributes": [
+
+          ],
+          "output_attributes": [
+            "intro_analysis_combined"
+          ],
+          "prompt": ""
         }
       ]
     }
   ],
   "attributes": {
-    "start_title": {
-      "name": "start_title",
+    "transcript": {
+      "name": "transcript",
       "type": "string",
       "is_array": false
     },
-    "start_keyword": {
-      "name": "start_keyword",
+    "outline": {
+      "name": "outline",
       "type": "string",
       "is_array": false
     },
-    "start_transcript": {
-      "name": "start_transcript",
+    "first_draft": {
+      "name": "first_draft",
       "type": "string",
       "is_array": false
     },
-    "potential_titles": {
-      "name": "potential_titles",
+    "intro_variations": {
+      "name": "intro_variations",
       "type": "array",
       "is_array": false
     },
-    "working_title": {
-      "name": "working_title",
+    "intro_variation": {
+      "name": "intro_variation",
+      "type": "string",
+      "is_array": false
+    },
+    "second_draft": {
+      "name": "second_draft",
+      "type": "string",
+      "is_array": false
+    },
+    "intro_analysis": {
+      "name": "intro_analysis",
+      "type": "string",
+      "is_array": false
+    },
+    "intro_analysis_combined": {
+      "name": "intro_analysis_combined",
       "type": "string",
       "is_array": false
     }
   },
-  "prompts": [
-    {
-      "name": "best_practice",
-      "path": "youtube/title_creator/best_practice.md"
-    }
-  ]
+  "prompts": {
+  }
 }

data/workflow.yaml

@@ -1,56 +1,82 @@
 ---
-:name: YouTube Title Creator
+:name: YouTube Transcript to Medium Article
 :sections:
-- :name: Research
+- :name: Analysis
   :order: 1
   :steps:
-  - :name: Starting Context
+  - :name: Generate Outline
     :order: 1
-    :input_attributes: []
-    :output_attributes: []
-    :prompt: :best_practice
-  - :name: Basic titles
+    :input_attributes:
+    - :transcript
+    :output_attributes:
+    - :outline
+    :prompt: Analyze [transcript] and generate a preliminary outline for a blog post.
+  - :name: Write First Draft
     :order: 2
     :input_attributes:
-    - :basic_title
-    - :basic_keyword
-    - :basic_transcript
+    - :outline
     :output_attributes:
-    - :potential_titles
-    :prompt: |
-      Keyword: [start_keyword]
-      Title: [start_title]
-
-      Transcript:
-
-      [start_transcript]
-  - :name: Working Title
+    - :first_draft
+    :prompt: Write a blog post based on [outline].
+  - :name: Generate Intros
     :order: 3
     :input_attributes:
-    - :potential_titles
+    - :first_draft
+    :output_attributes:
+    - :intro_variations
+    :prompt: Create 5 introduction variations for [first_draft].
+  - :name: Update Draft with Intro
+    :order: 4
+    :input_attributes:
+    - :first_draft
+    - :intro_variation
+    :output_attributes:
+    - :second_draft
+    :prompt: Update [first_draft] with a better intro [intro_variation].
+  - :name: Analyse Intro
+    :order: 5
+    :input_attributes:
+    - :second_draft
     :output_attributes:
-    - :working_title
+    - :intro_analysis
+    :prompt: Analyze the article [second_draft] introduction
+  - :name: Combine Intro Analysis
+    :order: 6
+    :input_attributes: []
+    :output_attributes:
+    - :intro_analysis_combined
+    :prompt: ''
 :attributes:
-  :start_title:
-    :name: :start_title
+  :transcript:
+    :name: :transcript
     :type: :string
     :is_array: false
-  :start_keyword:
-    :name: :start_keyword
+  :outline:
+    :name: :outline
     :type: :string
     :is_array: false
-  :start_transcript:
-    :name: :start_transcript
+  :first_draft:
+    :name: :first_draft
     :type: :string
     :is_array: false
-  :potential_titles:
-    :name: :potential_titles
+  :intro_variations:
+    :name: :intro_variations
     :type: :array
     :is_array: false
-  :working_title:
-    :name: :working_title
+  :intro_variation:
+    :name: :intro_variation
+    :type: :string
+    :is_array: false
+  :second_draft:
+    :name: :second_draft
+    :type: :string
+    :is_array: false
+  :intro_analysis:
+    :name: :intro_analysis
+    :type: :string
+    :is_array: false
+  :intro_analysis_combined:
+    :name: :intro_analysis_combined
     :type: :string
     :is_array: false
-:prompts:
-- :name: :best_practice
-  :path: youtube/title_creator/best_practice.md
+:prompts: {}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ad-agent_architecture
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - David Cruwys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k_log
@@ -89,8 +89,10 @@ files:
 - lib/ad/agent_architecture/dsl/agent_dsl.rb
 - lib/ad/agent_architecture/dsl/agent_workflow_dsl.rb.old
 - lib/ad/agent_architecture/dsl/attribute_dsl.rb
+- lib/ad/agent_architecture/dsl/child_dsl.rb
 - lib/ad/agent_architecture/dsl/prompt_dsl.rb
 - lib/ad/agent_architecture/dsl/section_dsl.rb
+- lib/ad/agent_architecture/dsl/settings_dsl.rb
 - lib/ad/agent_architecture/dsl/step_dsl.rb
 - lib/ad/agent_architecture/dsl/workflow_dsl.rb
 - lib/ad/agent_architecture/report/workflow_detail_report.rb