dev_suite 0.2.10 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92ff382f54afdf8f68f1f3d5f2f3bec8c496138b0af875b0970b2cceaec24e36
-  data.tar.gz: 743a74d46e4448c8e363d7b00e501bd1b2740eb5a10eb1bd019432cb01afd4ea
+  metadata.gz: 89babbbfc8efcac3d35e1f60db7c5c880183eb7b77f5d43cd0a9380081815795
+  data.tar.gz: 34000a8d5129edf959325eaf30244333484128f399a72cc07e91329597a719fe
 SHA512:
-  metadata.gz: 7dffd5d2cf8ca2f1712e4e9599e5432666e654a8b6c5696fc185a7898342f574018c2d1311fd96a832a956f4c3aacf1023a7c3ffd83523c3094fb8823b3133f2
-  data.tar.gz: db80d0b5c8d9f425ac520b59b6b0988bf5dabadaaaff2647312511aa47bb5eaf738661ec6efe6253028d031baedd49012b910cd0bda65dac6872eaa7c314affe
+  metadata.gz: 9aef9871a87ca4f4c076ad72191a179dc894acf9667b5ef1f1ca52389ce0c08dda75477d5f59fc611bbe2b0c6c26ef19df8a9ec0f4bfe1b025d83809390d6c1c
+  data.tar.gz: 0f99342d6399fde0bd6c7f3104bbcd490b64ae67f450d706f4518057c2534110660e420a24f2d38b5481a17757a97092e79f9d6bca450ea0b88273eeae959dda

data/.codeclimate.yml

@@ -1,12 +1,54 @@
 version: "2"
 checks:
-  argument_count:
+  argument-count:
     enabled: true
-  file_lines:
+  complexity:
     enabled: true
-ratings:
-  paths:
-    - "**.rb"
+  duplication:
+    enabled: true
+  file-lines:
+    enabled: true
+  method-lines:
+    enabled: true
+  return-statements:
+    enabled: true
+  similar-code:
+    enabled: true
+  npath-complexity:
+    enabled: true
+  identical-code:
+    enabled: true
+
+engines:
+  rubocop:
+    enabled: true
+    channel: rubocop-1-48-1
+    config:
+      file: .rubocop.yml
+  bundler-audit:
+    enabled: true
+    channel: bundler-audit-0-9-1
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 50
+          paths:
+            - "lib/**/*.rb"
+  fixme:
+    enabled: false
+    config:
+      strings:
+        - "TODO"
+        - "FIXME"
+
 exclude_patterns:
-  - "examples/**"  # Ignore examples folder
-  - "tmp/**"       # Ignore temp files
+  - "spec/"
+  - "test/"
+  - "vendor/"
+  - "bin/"
+  - "log/"
+  - "tmp/"
+  - "coverage/"
+  - "examples/"

data/Gemfile

@@ -21,3 +21,7 @@ group :development do
   gem "rubocop", "~> 1.65", require: false
   gem "rubocop-shopify", "~> 2.15", require: false
 end
+
+group :test do
+  gem "webmock", "~> 3.13"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.2.10)
+    dev_suite (0.2.12)
       benchmark (~> 0.1)
       csv (~> 3.0)
       get_process_mem (~> 1.0)
@@ -10,11 +10,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     benchmark (0.3.0)
     bigdecimal (3.1.8)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     csv (3.3.0)
     diff-lcs (1.5.1)
     docile (1.4.1)
@@ -47,6 +52,7 @@ GEM
     get_process_mem (1.0.0)
       bigdecimal (>= 2.0)
       ffi (~> 1.0)
+    hashdiff (1.1.1)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
@@ -60,10 +66,12 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
+    rexml (3.3.8)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -101,6 +109,10 @@ GEM
     simplecov_json_formatter (0.1.4)
     thor (1.3.2)
     unicode-display_width (2.5.0)
+    webmock (3.24.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-23
@@ -115,6 +127,7 @@ DEPENDENCIES
   rubocop (~> 1.65)
   rubocop-shopify (~> 2.15)
   simplecov (~> 0.21)
+  webmock (~> 3.13)
 
 BUNDLED WITH
    2.5.17

data/README.md

@@ -428,6 +428,10 @@ Trace all method calls within a specific block of code, including optional loggi
    🏁 #depth:1 < MathOperations#greet #=> "Hello, Ruby!" at (irb):12 in 0.02ms
 Hello, Ruby!
 ```
+
+  **Tips**:
+
+  Use `max_depth` to Limit Tracing: If you have deeply nested method calls, use the `max_depth` option to limit the depth of tracing. This can help reduce the amount of log output and focus on the most relevant parts of your code. A recommended value for `max_depth` is between `2` and `5`, depending on the complexity of your code.
 </details>
 
 ## Development

data/examples/setup.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "helpers/helpers"

data/examples/workflow/conditional_workflow.rb

@@ -7,7 +7,7 @@ require "dev_suite"
 engine = DevSuite::Workflow::Engine.new(user: "Bob", role: "admin")
 
 # Add a conditional step
-conditional_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", ->(ctx) {
+conditional_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", condition: ->(ctx) {
   ctx.get(:role) == "admin"
 }) do |context|
   puts "Welcome Admin, #{context.get(:user)}!"

data/examples/workflow/full_workflow.rb

@@ -20,14 +20,14 @@ greet_step = DevSuite::Workflow.create_step("Greet User") do |context|
 end
 
 # Step 2: Create a conditional step to greet only admins
-admin_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", ->(ctx) {
+admin_step = DevSuite::Workflow.create_conditional_step("Admin Greeting", condition: ->(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|
+loop_step = DevSuite::Workflow.create_loop_step("Loop Step", iterations: 3) do |ctx|
   iteration = ctx.get(:iteration_count) + 1
   ctx.update({ iteration_count: iteration })
   puts "Iteration #{iteration} completed."

data/examples/workflow/loop_workflow.rb

@@ -7,7 +7,7 @@ require "dev_suite"
 engine = DevSuite::Workflow::Engine.new(iteration_count: 0)
 
 # Add a loop step
-loop_step = DevSuite::Workflow.create_loop_step("Repeat Task", 3) do |context|
+loop_step = DevSuite::Workflow.create_loop_step("Repeat Task", iterations: 3) do |context|
   iteration = context.get(:iteration_count) + 1
   context.update({ iteration_count: iteration })
   puts "Iteration #{iteration}"

data/examples/workflow/order_processing_workflow.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../helpers"
+require_relative "../setup"
 
 $LOAD_PATH.unshift(File.expand_path("../../lib", __dir__))
 require "dev_suite"
@@ -95,7 +95,7 @@ register_step = DevSuite::Workflow.create_step("Register Users") do |ctx|
   ctx.data
 end
 
-save_users_step = DevSuite::Workflow.create_conditional_step("Save Users to Store", ->(ctx) {
+save_users_step = DevSuite::Workflow.create_conditional_step("Save Users to Store", condition: ->(ctx) {
   ctx.get(:users)&.any?
 }) do |ctx|
   ctx.store.set(:users, ctx.get(:users))
@@ -103,7 +103,7 @@ save_users_step = DevSuite::Workflow.create_conditional_step("Save Users to Stor
   ctx.data
 end
 
-login_step = DevSuite::Workflow.create_conditional_step("Login Users", ->(ctx) {
+login_step = DevSuite::Workflow.create_conditional_step("Login Users", condition: ->(ctx) {
   ctx.get(:username) && ctx.get(:password)
 }) do |ctx|
   response = login_user(ctx.get(:username), ctx.get(:password))
@@ -119,7 +119,7 @@ login_step = DevSuite::Workflow.create_conditional_step("Login Users", ->(ctx) {
   ctx.data
 end
 
-fetch_order_step = DevSuite::Workflow.create_conditional_step("Fetch Orders", ->(ctx) {
+fetch_order_step = DevSuite::Workflow.create_conditional_step("Fetch Orders", condition: ->(ctx) {
   ctx.get(:token) && ctx.get(:user_id)
 }) do |ctx|
   response = fetch_order(ctx.get(:token), ctx.get(:user_id))
@@ -134,7 +134,7 @@ fetch_order_step = DevSuite::Workflow.create_conditional_step("Fetch Orders", ->
   ctx.data
 end
 
-process_payment_step = DevSuite::Workflow.create_conditional_step("Process Payment", ->(ctx) {
+process_payment_step = DevSuite::Workflow.create_conditional_step("Process Payment", condition: ->(ctx) {
   ctx.get(:order_id) && ctx.get(:token) && ctx.get(:user_id)
 }) do |ctx|
   response = process_payment(ctx.get(:order_id), ctx.get(:token), ctx.get(:user_id))
@@ -155,9 +155,11 @@ workflow = DevSuite::Workflow.create_engine(
   path: STORE_PATH,
 )
 
-workflow.step(register_step)
-  .step(save_users_step)
-  .step(login_step)
-  .step(fetch_order_step)
-  .step(process_payment_step)
-  .execute
+DevSuite::MethodTracer.trace do
+  workflow.step(register_step)
+    .step(save_users_step)
+    .step(login_step)
+    .step(fetch_order_step)
+    .step(process_payment_step)
+    .execute
+end

data/lib/dev_suite/method_tracer/logger.rb

@@ -7,39 +7,70 @@ module DevSuite
         def log_method_call(tp, tracer)
           tracer.depth += 1
 
-          method_name = Helpers.format_method_name(tp)
-          params_str = Helpers.format_params(tp) if tracer.show_params
-          indent = Helpers.calculate_indent(tracer.depth)
-
           # Store the start time for execution time calculation
           tracer.start_times[tp.method_id] = Time.now
 
-          message = "#{indent}#depth:#{tracer.depth} > #{method_name} at #{tp.path}:#{tp.lineno} #{params_str}"
-          Utils::Logger.log(
-            message,
-            emoji: :start,
-            color: :blue,
-          )
+          message = build_call_message(tp, tracer)
+          Utils::Logger.log(message, emoji: :start, color: :blue)
         end
 
         def log_method_return(tp, tracer)
           duration = Helpers.calculate_duration(tp, tracer.start_times)
 
-          method_name = Helpers.format_method_name(tp)
-          result_str = Helpers.format_result(tp) if tracer.show_results
-          exec_time_str = Helpers.format_execution_time(duration) if tracer.show_execution_time
-          indent = Helpers.calculate_indent(tracer.depth)
-
-          message = "#{indent}#depth:#{tracer.depth} < #{method_name}#{result_str} at #{tp.path}:#{tp.lineno}#{exec_time_str}"
-          Utils::Logger.log(
-            message,
-            emoji: :finish,
-            color: :cyan,
-          )
+          message = build_return_message(tp, tracer, duration)
+          Utils::Logger.log(message, emoji: :finish, color: :cyan)
 
           # Decrement depth safely
           tracer.depth = [tracer.depth - 1, 0].max
         end
+
+        private
+
+        # Builds the log message for method calls
+        #
+        # @param tp [TracePoint] The TracePoint object
+        # @param tracer [Tracer] The tracer instance
+        # @return [String] The formatted log message
+        def build_call_message(tp, tracer)
+          method_name = colorize_text(Helpers.format_method_name(tp), :blue)
+          params_str = tracer.show_params ? colorize_text(Helpers.format_params(tp), :yellow) : ""
+          indent = Helpers.calculate_indent(tracer.depth)
+          depth_str = colorize_text("#depth:#{tracer.depth}", :magenta)
+
+          "#{indent}#{depth_str} > #{method_name} at #{tp.path}:#{tp.lineno} #{params_str}"
+        end
+
+        # Builds the log message for method returns
+        #
+        # @param tp [TracePoint] The TracePoint object
+        # @param tracer [Tracer] The tracer instance
+        # @param duration [Float] The execution time
+        # @return [String] The formatted log message
+        def build_return_message(tp, tracer, duration)
+          method_name = colorize_text(Helpers.format_method_name(tp), :cyan)
+          result_str = tracer.show_results ? colorize_text(Helpers.format_result(tp), :green) : ""
+          exec_time_str = if tracer.show_execution_time
+            colorize_text(
+              Helpers.format_execution_time(duration),
+              :light_white,
+            )
+          else
+            ""
+          end
+          indent = Helpers.calculate_indent(tracer.depth)
+          depth_str = colorize_text("#depth:#{tracer.depth}", :magenta)
+
+          "#{indent}#{depth_str} < #{method_name}#{result_str} at #{tp.path}:#{tp.lineno}#{exec_time_str}"
+        end
+
+        # Helper method to colorize text
+        #
+        # @param text [String] The text to colorize
+        # @param color [Symbol] The color to use
+        # @return [String] The colorized text
+        def colorize_text(text, color)
+          Utils::Color.colorize(text, color: color)
+        end
       end
     end
   end

data/lib/dev_suite/utils/color/colorizer.rb

@@ -5,7 +5,7 @@ module DevSuite
     module Color
       class Colorizer
         def colorize(text, **kargs)
-          puts Config.configuration.strategy.colorize(text, **kargs)
+          Config.configuration.strategy.colorize(text, **kargs)
         end
       end
 

data/lib/dev_suite/utils/color/palette/default.rb

@@ -6,6 +6,8 @@ module DevSuite
       module Palette
         class Default < Base
           COLORS = {
+            # Standard Colors
+            black: 30,
             red: 31,
             green: 32,
             yellow: 33,
@@ -14,6 +16,37 @@ module DevSuite
             cyan: 36,
             white: 37,
             default: 39,
+
+            # Light Colors
+            light_black: 90,
+            light_red: 91,
+            light_green: 92,
+            light_yellow: 93,
+            light_blue: 94,
+            light_magenta: 95,
+            light_cyan: 96,
+            light_white: 97,
+
+            # Background Colors
+            bg_black: 40,
+            bg_red: 41,
+            bg_green: 42,
+            bg_yellow: 43,
+            bg_blue: 44,
+            bg_magenta: 45,
+            bg_cyan: 46,
+            bg_white: 47,
+            bg_default: 49,
+
+            # Light Background Colors
+            bg_light_black: 100,
+            bg_light_red: 101,
+            bg_light_green: 102,
+            bg_light_yellow: 103,
+            bg_light_blue: 104,
+            bg_light_magenta: 105,
+            bg_light_cyan: 106,
+            bg_light_white: 107,
           }.freeze
         end
       end

data/lib/dev_suite/utils/construct/component/manager.rb

@@ -32,7 +32,12 @@ module DevSuite
 
               raise ArgumentError, "Component not found for key: #{component_key}" unless component_class
 
-              component_class.new(**options, &block)
+              # Check if options are empty to avoid passing unnecessary keyword arguments in Ruby 2.6
+              if options.empty?
+                component_class.new(&block)
+              else
+                component_class.new(**options, &block)
+              end
             end
 
             # Build multiple components by filtering registered ones

data/lib/dev_suite/utils/data/path_access/data_traverser.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "key_handler"
+
+module DevSuite
+  module Utils
+    module Data
+      module PathAccess
+        module DataTraverser
+          extend self
+
+          # Traverse nested data for retrieving a value
+          def fetch(data, keys)
+            keys.reduce(data) { |current, key| traverse_data(current, key) }
+          end
+
+          # Traverse nested data for setting a value
+          def assign(data, keys, value)
+            last_key = keys.pop
+            target = keys.reduce(data) { |current, key| traverse_or_create(current, key) }
+            set_final_value(target, last_key, value)
+          end
+
+          # Traverse nested data for deleting a value
+          def remove(data, keys)
+            last_key = keys.pop
+            target = keys.reduce(data) { |current, key| traverse_data(current, key) }
+            delete_final_value(target, last_key)
+          end
+
+          private
+
+          # Traverse through hash or array data types
+          def traverse_data(current, key)
+            KeyHandler.validate_path(current, key)
+            case current
+            when Hash
+              current[KeyHandler.find_key(current, key)]
+            when Array
+              current[key.to_i]
+            else
+              raise DataStructureError, "Unexpected data type at '#{key}'"
+            end
+          end
+
+          # Traverse or create new hash elements when setting a value
+          def traverse_or_create(current, key)
+            KeyHandler.validate_path(current, key)
+            case current
+            when Hash
+              current[KeyHandler.find_key(current, key)] ||= {}
+            when Array
+              current[key.to_i] ||= {}
+            else
+              raise DataStructureError, "Unexpected data type at '#{key}'"
+            end
+          end
+
+          # Set the final value in hash or array
+          def set_final_value(target, key, value)
+            case target
+            when Hash
+              target[KeyHandler.find_key(target, key)] = value
+            when Array
+              target[key] = value if key.is_a?(Integer)
+            else
+              raise DataStructureError, "Cannot set value on unsupported data type"
+            end
+          end
+
+          # Delete the final value from hash or array
+          def delete_final_value(target, key)
+            case target
+            when Hash
+              target.delete(KeyHandler.find_key(target, key))
+            when Array
+              target.delete_at(key) if key.is_a?(Integer)
+            else
+              raise DataStructureError, "Cannot delete key from unsupported data type"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/data/path_access/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Data
+      module PathAccess
+        class InvalidPathError < StandardError; end
+        class DataStructureError < StandardError; end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/data/path_access/key_handler.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Data
+      module PathAccess
+        module KeyHandler
+          extend self
+
+          # Find an existing key in a hash, handling both symbol and string keys
+          def find_key(hash, key)
+            return key if hash.key?(key)
+            return key.to_s if hash.key?(key.to_s)
+            return key.to_sym if hash.key?(key.to_sym)
+
+            key
+          end
+
+          # Validate the path by checking if it's pointing to a valid data structure
+          def validate_path(data, key)
+            raise InvalidPathError, "Invalid path at '#{key}'" if data.nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/data/path_access/path_accessor.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "path_parser"
+require_relative "data_traverser"
+require_relative "key_handler"
+require_relative "errors"
+
+module DevSuite
+  module Utils
+    module Data
+      module PathAccess
+        module PathAccessor
+          extend self
+
+          # Get value from nested data
+          def get(data, path)
+            keys = PathParser.parse(path)
+            DataTraverser.fetch(data, keys)
+          end
+
+          # Set value in nested data
+          def set(data, path, value)
+            keys = PathParser.parse(path)
+            DataTraverser.assign(data, keys, value)
+          end
+
+          # Delete key in nested data
+          def delete(data, path)
+            keys = PathParser.parse(path)
+            DataTraverser.remove(data, keys)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/data/path_access/path_parser.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Data
+      module PathAccess
+        module PathParser
+          extend self
+
+          def parse(path)
+            return path if path.is_a?(Array)
+            return parse_symbol_path(path) if path.is_a?(Symbol)
+            return parse_string_path(path) if path.is_a?(String)
+
+            [path]
+          end
+
+          private
+
+          def parse_symbol_path(symbol_path)
+            symbol_path.to_s.split(/\.|\[|\]/).reject(&:empty?).map { |part| parse_part(part) }
+          end
+
+          def parse_string_path(string_path)
+            string_path.split(/\.|\[|\]/).reject(&:empty?).map { |part| parse_part(part) }
+          end
+
+          def parse_part(part)
+            part.match?(/^\d+$/) ? part.to_i : part.to_sym
+          end
+        end
+      end
+    end
+  end
+end