dev_suite 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a7188e92386a13da83abc637b7446d68c485eff8e6e2198a53f88360ac13f02
-  data.tar.gz: f76c576284ba7b90bc671a389cd6e43065079f04ae19567b0e633a147e2b2276
+  metadata.gz: 46a0bbcc4003a1f927cd0e4b8b1ffbc0a5045b48a7f5a5f7afc1d64b779ee636
+  data.tar.gz: 9500cbcf2e4b9e3ca4f15e523364b8b2a4508e3c336a3675d1bff78b80d8cb27
 SHA512:
-  metadata.gz: b565a159f2aee25115301ae629dcd2e44e844005586c2505e92cd18f75f9845a856c16f8db1c5a309eb249f645ba1e90b6c36ca4e0958f6106f39d0d86f7434a
-  data.tar.gz: 7a34933bf806f8e3fb09351b200698da8d6f5568fefc3054f7ba0591c939dc264b9962c77cd56b6f01e5304b2bb60e5301885f33f34b05bebd54858046cb1e73
+  metadata.gz: 586986165449f7145547b0ac188cef0e2b9b75ed69c74e320898a3c33eccce00c0c4b383c23f9b32a6a0bc50470bccdc018339f9a7240fcbcb176595a9a00b35
+  data.tar.gz: ff3e828d65d93aa9f8bbfb320c25cd3b1216bf66a03169ba269748eb3d2ec38851527beeb369b2e0edf5f058cbe3ca91b6680061eb590b9f149cbdce604143ab

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0  # Specify your project's Ruby version
+          ruby-version: 3.0
 
       - name: Install dependencies
         run: bundle install

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.2.7)
+    dev_suite (0.2.9)
       benchmark (~> 0.1)
+      csv (~> 3.0)
       get_process_mem (~> 1.0)
       thor (~> 1.1)
 
@@ -13,6 +14,7 @@ GEM
     benchmark (0.3.0)
     bigdecimal (3.1.8)
     coderay (1.1.3)
+    csv (3.3.0)
     diff-lcs (1.5.1)
     docile (1.4.1)
     faraday (1.10.3)
@@ -56,8 +58,8 @@ GEM
     language_server-protocol (3.17.0.3)
     method_source (1.1.0)
     multipart-post (2.4.1)
-    parallel (1.25.1)
-    parser (3.3.4.1)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -67,8 +69,6 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.6)
-      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -82,18 +82,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.65.1)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.0)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
@@ -105,8 +104,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    strscan (3.1.0)
-    thor (1.3.1)
+    thor (1.3.2)
     unicode-display_width (2.5.0)
 
 PLATFORMS

data/README.md

@@ -214,6 +214,148 @@ Log detailed HTTP requests and responses across different adapters like Net::HTT
   ```
 </details>
 
+### Workflow Engine
+Manage complex workflows consisting of multiple sequential steps, including handling data between steps and supporting dynamic operations like conditionals, loops, and parallel execution.
+
+<details>
+  <summary>Show more</summary>
+
+  **How to Use**:
+  ```ruby
+  workflow = DevSuite::Workflow.create_engine(initial_context)
+
+  # Define steps
+  step1 = DevSuite::Workflow.create_step("Step 1") do |ctx|
+    ctx.update({ result: "Step 1 Complete" })
+  end
+
+  step2 = DevSuite::Workflow.create_step("Step 2") do |ctx|
+    puts "Previous Result: #{ctx.get(:result)}"
+    ctx.update({ result: "Step 2 Complete" })
+  end
+
+  # Chain steps together
+  workflow.add_step(step1).add_step(step2)
+
+  # Execute workflow
+  workflow.execute
+  ```
+
+  **Chaining Steps**:
+  You can chain multiple steps together to create a workflow:
+  ```ruby
+  workflow = DevSuite::Workflow.create_engine(initial_context)
+  
+  step1 = DevSuite::Workflow.create_step("Step 1") { |ctx| ctx.update({ data: 'Data from Step 1' }) }
+  step2 = DevSuite::Workflow.create_step("Step 2") { |ctx| puts "Received: #{ctx.get(:data)}" }
+
+  workflow.add_step(step1)
+          .add_step(step2)
+          .execute
+  ```
+
+  **Data Handling**:
+  Each step in the workflow has access to a shared context, where you can store and retrieve data:
+  ```ruby
+  workflow = DevSuite::Workflow.create_engine({ some_key: 'initial_value' })
+
+  step1 = DevSuite::Workflow.create_step("Step 1") do |ctx|
+    # Retrieve data
+    puts ctx.get(:some_key)  # Output: initial_value
+    # Set data
+    ctx.update({ new_key: 'new_value' })
+  end
+
+  step2 = DevSuite::Workflow.create_step("Step 2") do |ctx|
+    # Use updated data
+    puts ctx.get(:new_key)  # Output: new_value
+  end
+
+  workflow.add_step(step1).add_step(step2).execute
+  ```
+
+  **Conditional Execution**:
+  Conditionally execute steps based on logic defined in the workflow context:
+  ```ruby
+  conditional_step = DevSuite::Workflow.create_conditional_step("Conditional Step", ->(ctx) { ctx.get(:result) == "Step 1 Complete" }) do |ctx|
+    puts "Condition met! Executing conditional step."
+    ctx.update({ result: "Conditional Step Executed" })
+  end
+
+  workflow.add_step(conditional_step).execute
+  ```
+
+  **Parallel Execution**:
+  You can execute multiple steps in parallel:
+  ```ruby
+  parallel_step = DevSuite::Workflow.create_parallel_step("Parallel Step") do |ctx|
+    [
+      ->(ctx) { ctx.update({ task1: "Task 1 done" }) },
+      ->(ctx) { ctx.update({ task2: "Task 2 done" }) }
+    ]
+  end
+
+  workflow.add_step(parallel_step).execute
+  ```
+
+  **Save and Load Context**:
+  Save the workflow's context to a file and reload it for later use:
+  ```ruby
+  # Saving context to a YAML file
+  workflow = DevSuite::Workflow.create_engine({ user: 'John' })
+  workflow.add_step(DevSuite::Workflow.create_step("Example") { |ctx| ctx.update({ status: 'completed' }) })
+  workflow.execute
+
+  File.open('context.yml', 'w') { |file| file.write(YAML.dump(workflow.context.data)) }
+
+  # Loading context from a YAML file
+  loaded_data = YAML.load_file('context.yml')
+  workflow = DevSuite::Workflow.create_engine(loaded_data)
+  ```
+
+  **Looping**:
+  You can loop steps in the workflow, for instance, if you need to repeat a step multiple times:
+  ```ruby
+  loop_step = DevSuite::Workflow.create_loop_step("Repeat 5 Times", 5) do |ctx|
+    count = ctx.get(:count) || 0
+    ctx.update({ count: count + 1 })
+    puts "Iteration: #{ctx.get(:count)}"
+  end
+
+  workflow.add_step(loop_step).execute
+  ```
+
+  **Using the Store**:
+  By default, the workflow context provides access to an integrated store via ctx.store. You can save and retrieve data across steps:
+  ```ruby
+  # Using the store in the workflow
+  workflow = DevSuite::Workflow.create_engine
+  step = DevSuite::Workflow.create_step("Store Example") do |ctx|
+    ctx.store.set(:step_result, "Step 1 Completed")
+  end
+
+  workflow.add_step(step).execute
+
+  # Fetch data from the store
+  puts ctx.store.fetch(:step_result)  # Output: Step 1 Completed
+  ```
+
+  **Sample Output**:
+  ```bash
+  Step 1 executed: result => Step 1 Complete
+  Step 2 executed: Previous Result: Step 1 Complete
+  Task 1 done
+  Task 2 done
+  Iteration: 1
+  Iteration: 2
+  ...
+  Condition met! Executing conditional step.
+  Store contains: { name: "John Doe", age: 30 }
+  Step 1 Completed
+  ```
+
+</details>
+
 ## Development
 
 After checking out the repo, run `bin/setup`for an interactive prompt that will allow you to experiment.

data/dev_suite.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
 
   # Runtime dependencies
   spec.add_dependency("benchmark", "~> 0.1")
+  spec.add_dependency("csv", "~> 3.0")
   spec.add_dependency("get_process_mem", "~> 1.0")
   spec.add_dependency("thor", "~> 1.1")
 end

data/examples/workflow/basic_workflow.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create a basic workflow
+engine = DevSuite::Workflow::Engine.new(user: "Alice")
+
+# Add a basic step
+basic_step = DevSuite::Workflow.create_step("Greet User") do |context|
+  puts "Hello, #{context.get(:user)}!"
+end
+
+engine.add_step(basic_step)
+engine.execute

data/examples/workflow/composite_workflow.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create a workflow with multiple sub-steps
+engine = DevSuite::Workflow::Engine.new
+
+composite_step = DevSuite::Workflow.create_composite_step("Composite Task")
+
+# Add sub-steps
+sub_step1 = DevSuite::Workflow.create_step("Sub-Step 1") do |context|
+  puts "Executing Sub-Step 1"
+end
+sub_step2 = DevSuite::Workflow.create_step("Sub-Step 2") do |context|
+  puts "Executing Sub-Step 2"
+end
+
+composite_step.add_step(sub_step1).add_step(sub_step2)
+engine.add_step(composite_step)
+engine.execute

data/examples/workflow/conditional_workflow.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create a conditional workflow
+engine = DevSuite::Workflow::Engine.new(user: "Bob", role: "admin")
+
+# Add a conditional step
+conditional_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", ->(ctx) {
+  ctx.get(:role) == "admin"
+}) do |context|
+  puts "Welcome Admin, #{context.get(:user)}!"
+end
+
+engine.add_step(conditional_step)
+engine.execute

data/examples/workflow/full_workflow.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create the workflow engine with an initial context
+engine = DevSuite::Workflow.create_engine(
+  {
+    user: "Alice",
+    role: "admin",
+    iteration_count: 0,
+  },
+  driver: :file,
+  path: "tmp/workflow_store.json",
+)
+
+# Step 1: Create a basic step to greet the user
+greet_step = DevSuite::Workflow.create_step("Greet User") do |context|
+  puts "Hello, #{context.get(:user)}!"
+end
+
+# Step 2: Create a conditional step to greet only admins
+admin_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", ->(ctx) {
+  ctx.get(:role) == "admin"
+}) do |context|
+  puts "Welcome, Admin #{context.get(:user)}!"
+end
+
+# Step 3: Create a loop step that repeats 3 times
+loop_step = DevSuite::Workflow.create_loop_step("Loop Step", 3) do |ctx|
+  iteration = ctx.get(:iteration_count) + 1
+  ctx.update({ iteration_count: iteration })
+  puts "Iteration #{iteration} completed."
+end
+
+# Step 4: Create a parallel step to run two tasks simultaneously
+parallel_step = DevSuite::Workflow.create_parallel_step("Parallel Task") do |context|
+  [
+    ->(ctx) { puts "Task 1 executed" },
+    ->(ctx) { puts "Task 2 executed" },
+  ]
+end
+
+# Step 5: Create a composite step that combines two sub-steps
+composite_step = DevSuite::Workflow.create_composite_step("Composite Task")
+
+# Sub-Step 1
+sub_step1 = DevSuite::Workflow.create_step("Sub-Step 1") do |context|
+  puts "Executing Sub-Step 1"
+end
+
+# Sub-Step 2
+sub_step2 = DevSuite::Workflow.create_step("Sub-Step 2") do |context|
+  puts "Executing Sub-Step 2"
+end
+
+# Add sub-steps to the composite step
+composite_step.add_step(sub_step1).add_step(sub_step2)
+
+# Step 6: A step to store the final workflow result
+store_step = DevSuite::Workflow.create_step("Store Result") do |context|
+  context.store.set(:workflow_result, "Workflow Completed")
+  puts "Result stored in context."
+end
+
+# Add all steps to the workflow engine
+engine.add_step(greet_step)
+  .add_step(admin_step)
+  .add_step(loop_step)
+  .add_step(parallel_step)
+  .add_step(composite_step)
+  .add_step(store_step)
+
+# Execute the workflow
+puts "Executing workflow..."
+engine.execute
+
+# Retrieve the result from the context store after execution
+puts "Final result from context store: #{engine.context.store.fetch(:workflow_result)}"

data/examples/workflow/loop_workflow.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create a workflow with a looping step
+engine = DevSuite::Workflow::Engine.new(iteration_count: 0)
+
+# Add a loop step
+loop_step = DevSuite::Workflow.create_loop_step("Repeat Task", 3) do |context|
+  iteration = context.get(:iteration_count) + 1
+  context.update({ iteration_count: iteration })
+  puts "Iteration #{iteration}"
+end
+
+engine.add_step(loop_step)
+engine.execute

data/examples/workflow/parallel_workflow.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
+require "dev_suite"
+
+# Create a workflow with parallel tasks
+engine = DevSuite::Workflow::Engine.new
+
+parallel_step = DevSuite::Workflow.create_parallel_step("Parallel Task") do |context|
+  [
+    ->(ctx) { puts "Task 1 executed" },
+    ->(ctx) { puts "Task 2 executed" },
+  ]
+end
+
+engine.add_step(parallel_step)
+engine.execute

data/lib/dev_suite/dev_suite.rb

@@ -7,6 +7,8 @@ module DevSuite
   require_relative "performance"
   require_relative "directory_tree"
   require_relative "request_logger"
+  require_relative "request_builder"
+  require_relative "workflow"
 
   class Error < StandardError; end
 end

data/lib/dev_suite/request_builder/builder/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Builder
+      class Base
+        attr_reader :url, :headers, :tool
+
+        def initialize(url:, headers: {}, tool:)
+          @url = url
+          @headers = headers
+          @tool = tool
+        end
+
+        def build_command
+          raise NotImplementedError, "Subclasses must implement the `build_command` method"
+        end
+
+        protected
+
+        def format_headers
+          headers.map { |key, value| "#{key}: #{value}" }.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/builder/builder.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Builder
+      require_relative "base"
+      require_relative "http"
+    end
+  end
+end

data/lib/dev_suite/request_builder/builder/http.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Builder
+      class Http < Base
+        attr_reader :http_method, :body
+
+        def initialize(url:, http_method: "GET", headers: {}, body: nil, tool:)
+          super(url: url, headers: headers, tool: tool)
+          @http_method = http_method.upcase
+          @body = body
+        end
+
+        def build_command
+          case tool
+          when :curl
+            Tool::Curl.new.build_command(http_method: http_method, url: url, headers: headers, body: format_body(body))
+          else
+            raise ArgumentError, "Unknown tool: #{tool}"
+          end
+        end
+
+        private
+
+        def format_body(body)
+          Formatter::Graphql.new.format_body(body)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/builder.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Builder
+      require_relative "builder/builder"
+    end
+  end
+end

data/lib/dev_suite/request_builder/config/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Config
+      include Utils::Construct::Config::Manager
+
+      require_relative "configuration"
+    end
+  end
+end

data/lib/dev_suite/request_builder/config/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Config
+      class Configuration < Utils::Construct::Config::Base
+        set_default_settings(
+          tool: {
+            curl: {
+              use_insecure: false,
+              raw_data: false,
+              verbose: false,
+              follow_redirects: true,
+              cookie: nil,
+              user_agent: "Mozilla/5.0 (compatible; RequestBuilder/1.0)",
+              max_time: nil,
+              connect_timeout: nil,
+            },
+          },
+        )
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Config
+      require_relative "config/config"
+    end
+  end
+end

data/lib/dev_suite/request_builder/formatter/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Formatter
+      class Base
+        def format_body(body)
+          raise NotImplementedError, "Subclasses must implement the `format_body` method"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/formatter/formatter.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Formatter
+      require_relative "base"
+      require_relative "graphql"
+    end
+  end
+end

data/lib/dev_suite/request_builder/formatter/graphql.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Formatter
+      class Graphql < Base
+        def format_body(body)
+          if body.is_a?(Hash) && body[:query] && body[:variables]
+            { query: body[:query], variables: body[:variables] }.to_json
+          elsif body.is_a?(String)
+            { query: body, variables: {} }.to_json
+          else
+            raise ArgumentError, "Invalid GraphQL body format"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/formatter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Formatter
+      require_relative "formatter/formatter"
+    end
+  end
+end

data/lib/dev_suite/request_builder/request_builder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    require_relative "config"
+    require_relative "formatter"
+    require_relative "tool"
+    require_relative "builder"
+
+    class << self
+      def build(protocol:, tool:, **options)
+        case protocol
+        when :http
+          Builder::Http.new(tool: tool, **options)
+        else
+          raise ArgumentError, "Unknown protocol: #{protocol}"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_builder/tool/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestBuilder
+    module Tool
+      class Base < Utils::Construct::Component::Base
+        def build_command(http_method:, url:, headers:, body: nil)
+          raise NotImplementedError
+        end
+
+        private
+
+        def fetch_setting(key, default: nil)
+          Config.configuration.settings.get(key, default: default)
+        end
+      end
+    end
+  end
+end