dev_suite 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6765c4b9fa4637dafaac36da47cd8adf18652cd0d38804ddcd8641b851669f12
-  data.tar.gz: 3a3b27ad8b9fa4319829175995b1d6ea999e9877d537b1316b531247d6bd4b53
+  metadata.gz: d90d0f33e4d0651dbc5ed388a62c7c0b3a665cb27db805631d8771245b21129e
+  data.tar.gz: e87b028766648877eea33d3c2910d3879510a50d4425fd9b19bf96212cb141a7
 SHA512:
-  metadata.gz: c2c9a91ccdfe89d997d66e8441d0b130dacc9edeb5fae6a3f949f1e25ff9aec09c41603597dbc7e017e9e3857c838e88182e4b670c220ea376d28934eb45c6e4
-  data.tar.gz: 4f2e69b97a36b68eb84d2c808ede9072b6f333aebe7f2049d16dc7c55e99592604e9e7234b36471d8d84208fec05cfa27b8ce9b942e93d566159209d7fe652d2
+  metadata.gz: c7a4fdb6138b2c9e75bafa923f095479827d58c229fdc60f2ae8c2b5e2a6a04f8e39c6ed27cf26ab3c53a62f606c5931c851698c1b577f6bdb1bad45289b344e
+  data.tar.gz: 1d10bd660e02d4100ee58fb7607626cfaf2ef714811a9407d25ae12f9fe71ae3ed9fd36d8b21de8bdba6b288223ed9a8b58ae22deb6e3ac297d24692e90ca86e

data/Gemfile

@@ -7,6 +7,8 @@ gemspec
 
 # Additional development tools not required as part of the gem's runtime
 group :development, :test do
+  gem "rspec", "~> 3.9"
+  gem "simplecov", "~> 0.21"
   gem "rake", "~> 13.0"
   gem "pry", "~> 0.14"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.2.4)
+    dev_suite (0.2.5)
       benchmark (~> 0.1)
       get_process_mem (~> 1.0)
       thor (~> 1.1)

data/README.md

@@ -153,6 +153,59 @@ DevSuite also provides a command-line interface for various utilities. Below are
   ```
 </details>
 
+### Request Logging
+<details>
+  <summary>Show more</summary>
+  
+  **Purpose**: The `RequestLogger` feature enables detailed logging of HTTP requests and responses across different adapters (e.g., `Net::HTTP`, `Faraday`). This can be useful for debugging, monitoring, and auditing API interactions.
+
+  **How to Use**:
+  ```ruby
+  require 'dev_suite'
+
+  DevSuite::RequestLogger.with_logging do 
+    # Make an HTTP request using Net::HTTP
+    uri = URI('https://jsonplaceholder.typicode.com/posts')
+    response = Net::HTTP.get(uri)
+  end
+  ```
+
+  **Configuration Guide**:
+  Customize the request logging behavior by setting configuration options:
+  ```ruby
+  DevSuite::RequestLogger.configure do |config|
+    config.adapters = [:net_http]
+    ...
+  end
+  ```
+
+  **Configuration Options**:
+  
+  Below is a table describing the available configuration settings:
+
+  | Setting        | Description                                        | Example Values                     |
+  |----------------|----------------------------------------------------|------------------------------------|
+  | `:adapters` | List of adapters for which logging is enabled.    | `[:net_http, :faraday]`            |
+  <!-- | `:log_level`       | Set the logging level (e.g., info, debug).         | `:info`, `:debug`, `:warn`, `:error` |
+  | `:log_response`    | Enable or disable response logging.                | `true`, `false`                    |
+  | `:log_emoji`       | Customize emojis for request and response logs.    | `{ request: :globe, response: :envelope }` | -->
+
+  **Adapters Supported**:
+  
+  The `RequestLogger` currently supports the following adapters:
+  
+  | Adapter      | Description                                | Example Usage                                      |
+  |--------------|--------------------------------------------|---------------------------------------------------|
+  | `Net::HTTP`  | Logs requests made with the Net::HTTP class.| `DevSuite::RequestLogger::Adapter::NetHttp.new(config)` |
+<!--   | `Faraday`    | Logs requests made with the Faraday gem.    | `DevSuite::RequestLogger::Adapter::Faraday.new(config)` | -->
+
+  **Sample Output**:
+  ```bash
+  [INFO] 🌐 Net::HTTP Request: GET http://example.com
+  [DEBUG] 📄 Net::HTTP Response: 200 OK
+  ```
+</details>
+
 ## Development
 
 After checking out the repo, run `bin/setup`for an interactive prompt that will allow you to experiment.

data/dev_suite.gemspec

@@ -33,8 +33,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency("benchmark", "~> 0.1")
   spec.add_dependency("get_process_mem", "~> 1.0")
   spec.add_dependency("thor", "~> 1.1")
-
-  # Development dependencies
-  spec.add_development_dependency("rspec", "~> 3.9")
-  spec.add_development_dependency("simplecov", "~> 0.21")
 end

data/lib/dev_suite/cli/commands/base.rb

@@ -4,8 +4,6 @@ module DevSuite
   module CLI
     module Commands
       class Base < Thor
-        include ErrorHandler
-
         desc "execute", "Execute the command"
         def execute
           raise NotImplementedError

data/lib/dev_suite/cli/commands/tree.rb

@@ -6,14 +6,14 @@ module DevSuite
       class Tree < Base
         desc "visualize PATH", "Visualize the directory structure at given PATH"
         def execute(path, options: {})
-          Logger.log("Starting visualization for: #{path}", emoji: :start)
+          Utils::Logger.log("Starting visualization for: #{path}", emoji: :start)
 
           apply_configure(options)
           visualize(path)
 
-          Logger.log("Visualization complete!", emoji: :success)
+          Utils::Logger.log("Visualization complete!", emoji: :success)
         rescue StandardError => e
-          ErrorHandler.handle_error(e)
+          Utils::ErrorHandler.handle_error(e)
         end
 
         private

data/lib/dev_suite/cli/commands/version.rb

@@ -5,7 +5,7 @@ module DevSuite
     module Commands
       class Version < Base
         def execute
-          Logger.log("DevSuite version: #{DevSuite::VERSION} is live!", emoji: :start)
+          Utils::Logger.log("DevSuite version: #{DevSuite::VERSION} is live!", emoji: :start)
         end
       end
     end

data/lib/dev_suite/cli/main.rb

@@ -25,7 +25,7 @@ module DevSuite
       def execute_command(command_class, *args, **kargs)
         command_class.new.execute(*args, **kargs)
       rescue StandardError => e
-        ErrorHandler.handle_error(e)
+        Utils::ErrorHandler.handle_error(e)
       end
     end
   end

data/lib/dev_suite/dev_suite.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  require_relative "version"
+  require_relative "utils"
+  require_relative "cli"
+  require_relative "performance"
+  require_relative "directory_tree"
+  require_relative "request_logger"
+
+  class Error < StandardError; end
+end

data/lib/dev_suite/directory_tree/config/config.rb

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Config
+      class Configuration < BaseConfiguration
+        set_default_settings(
+          skip_hidden: false,
+          skip_types: [],
+          max_depth: nil,
+          max_size: 100 * 1024 * 1024, # 100 MB
+        )
+
+        # Define configuration attributes
+        config_attr :builder, default_value: :base, type: :symbol, resolver: ->(value) { Builder.create(value) }
+        config_attr :renderer, default_value: :simple, type: :symbol, resolver: ->(value) { Renderer.create(value) }
+        config_attr :visualizer, default_value: :tree, type: :symbol, resolver: ->(value) { Visualizer.create(value) }
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/config.rb

@@ -2,42 +2,8 @@
 
 module DevSuite
   module DirectoryTree
-    class Config
-      include Utils::ConfigTools::Configuration
-
-      # Define configuration attributes
-      config_attr :settings, default_value: {}
-      config_attr :builder, default_value: :base
-      config_attr :renderer, default_value: :simple
-      config_attr :visualizer, default_value: :tree
-
-      private
-
-      def validate_attr!(attr, value)
-        case attr
-        when :settings
-          validate_hash!(attr, value)
-        when :builder, :renderer, :visualizer
-          validate_symbol!(attr, value)
-        else
-          raise ArgumentError, "Invalid attribute: #{attr}"
-        end
-      end
-
-      def resolve_attr(attr, value)
-        case attr
-        when :settings
-          Settings.new(value)
-        when :builder
-          Builder.create(value)
-        when :renderer
-          Renderer.create(value)
-        when :visualizer
-          Visualizer.create(value)
-        else
-          super # Return the value directly if no special resolution is needed
-        end
-      end
+    module Config
+      require_relative "config/config"
     end
   end
 end

data/lib/dev_suite/directory_tree/directory_tree.rb

@@ -6,7 +6,6 @@ module DevSuite
 
     require_relative "node"
     require_relative "config"
-    require_relative "settings"
     require_relative "renderer"
     require_relative "builder"
     require_relative "visualizer"

data/lib/dev_suite/directory_tree/renderer/base.rb

@@ -4,12 +4,6 @@ module DevSuite
   module DirectoryTree
     module Renderer
       class Base
-        attr_reader :settings
-
-        def initialize(settings: Settings.new)
-          @settings = settings
-        end
-
         def render
           raise NotImplementedError
         end

data/lib/dev_suite/performance/analyzer.rb

@@ -25,7 +25,7 @@ module DevSuite
       # @param benchmark_result [Benchmark::Tms] The benchmark result
       # @param memory_stats [Hash] The memory statistics
       def generate_report(results)
-        Config.configuration.reportor.generate(
+        Config.configuration.reporter.generate(
           description: @description,
           results: results,
         )

data/lib/dev_suite/performance/config/config.rb

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

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    module Config
+      class Configuration < BaseConfiguration
+        # Define configuration attributes
+        config_attr :profilers,
+          default_value: [:execution_time, :memory],
+          type: :array,
+          resolver: :resolve_profilers
+
+        config_attr :reporter,
+          default_value: :simple,
+          type: :symbol,
+          resolver: :resolve_reporter
+
+        private
+
+        def resolve_profilers(value)
+          Profiler.create_multiple(value)
+        end
+
+        def resolve_reporter(value)
+          Reporter.create(value)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/performance/config.rb

@@ -2,36 +2,8 @@
 
 module DevSuite
   module Performance
-    class Config
-      include Utils::ConfigTools::Configuration
-
-      # Define configuration attributes
-      config_attr :profilers, default_value: [:execution_time, :memory]
-      config_attr :reportor, default_value: :simple
-
-      private
-
-      def validate_attr!(attr, value)
-        case attr
-        when :profilers
-          validate_array!(attr, value)
-        when :reportor
-          validate_symbol!(attr, value)
-        else
-          raise ArgumentError, "Invalid attribute: #{attr}"
-        end
-      end
-
-      def resolve_attr(attr, value)
-        case attr
-        when :profilers
-          Profiler.create_multiple(value)
-        when :reportor
-          Reportor.create(value)
-        else
-          value
-        end
-      end
+    module Config
+      require_relative "config/config"
     end
   end
 end

data/lib/dev_suite/performance/{reportor → reporter}/base.rb

@@ -2,7 +2,7 @@
 
 module DevSuite
   module Performance
-    module Reportor
+    module Reporter
       class Base
         def generate
           raise NotImplementedError, "Subclasses must implement the generate method"

data/lib/dev_suite/performance/{reportor → reporter}/helpers/stat_mappings.rb

@@ -2,7 +2,7 @@
 
 module DevSuite
   module Performance
-    module Reportor
+    module Reporter
       module Helpers
         module StatMappings
           PROFILER_STAT_TITLES = {

data/lib/dev_suite/performance/{reportor → reporter}/helpers/table_builder.rb

@@ -2,7 +2,7 @@
 
 module DevSuite
   module Performance
-    module Reportor
+    module Reporter
       module Helpers
         module TableBuilder
           class << self

data/lib/dev_suite/performance/{reportor → reporter}/helpers.rb

@@ -2,7 +2,7 @@
 
 module DevSuite
   module Performance
-    module Reportor
+    module Reporter
       module Helpers
         require_relative "helpers/stat_mappings"
         require_relative "helpers/table_builder"

data/lib/dev_suite/performance/{reportor → reporter}/simple.rb

@@ -2,7 +2,7 @@
 
 module DevSuite
   module Performance
-    module Reportor
+    module Reporter
       class Simple < Base
         #
         # Generates the performance report

data/lib/dev_suite/performance/reporter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Performance
+    module Reporter
+      require_relative "reporter/base"
+      require_relative "reporter/simple"
+      require_relative "reporter/helpers"
+
+      class << self
+        def create(reporter)
+          case reporter
+          when :simple
+            Simple.new
+          else
+            raise ArgumentError, "Invalid reporter: #{reporter}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/performance.rb

@@ -8,7 +8,7 @@ module DevSuite
     require_relative "performance/data"
     require_relative "performance/profiler"
     require_relative "performance/profiler_manager"
-    require_relative "performance/reportor"
+    require_relative "performance/reporter"
     require_relative "performance/analyzer"
     require_relative "performance/config"
   end

data/lib/dev_suite/request_logger/adapter/adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestLogger
+    module Adapter
+      require "net/http"
+
+      require_relative "base"
+      require_relative "net_http"
+
+      class << self
+        def create(adapter)
+          case adapter
+          when :net_http
+            NetHttp.new
+          else
+            raise ArgumentError, "Adapter not found: #{adapter}"
+          end
+        end
+
+        def create_multiple(adapters)
+          adapters.map { |adapter| create(adapter) }
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_logger/adapter/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestLogger
+    module Adapter
+      class Base
+        def enable
+          raise NotImplementedError
+        end
+
+        def disable
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_logger/adapter/net_http.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestLogger
+    module Adapter
+      class NetHttp < Base
+        # Enables the logging of Net::HTTP requests by monkey patching the request method
+        def enable
+          ::Net::HTTP.class_eval do
+            # Alias the original request method with a unique name (_original_request)
+            # This preserves the original functionality so it can still be called after logging is added
+            alias_method(:_original_request, :request)
+
+            # Override the request method to add logging functionality
+            def request(request, body = nil, &block)
+              # Log the full URL of the HTTP request using the DevSuite::Utils::Logger
+              Logger.log_request(self, request)
+
+              # Call the original request method (now aliased as _original_request) to perform the actual HTTP request
+              response = _original_request(request, body, &block)
+
+              # Optionally log the response details
+              Logger.log_response(self, response)
+
+              # Return the response object so that the calling code receives the expected result
+              response
+            end
+          end
+        end
+
+        # Disables the logging by restoring the original Net::HTTP request method
+        def disable
+          ::Net::HTTP.class_eval do
+            # Restore the original request method by aliasing it back from _original_request
+            # This effectively removes the logging functionality and returns Net::HTTP to its original state
+            alias_method(:request, :_original_request)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_logger/adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestLogger
+    module Adapter
+      require_relative "adapter/adapter"
+    end
+  end
+end

data/lib/dev_suite/request_logger/config/config.rb

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

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module RequestLogger
+    module Config
+      class Configuration < BaseConfiguration
+        set_default_settings(
+          log_headers: true,
+          log_cookies: true,
+          log_body: true,
+          log_level: :debug,
+        )
+
+        config_attr :adapters, default_value: [:net_http], type: :array, resolver: :resolve_adapters
+
+        private
+
+        def resolve_adapters(value)
+          Adapter.create_multiple(value)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/request_logger/config.rb

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