dev_suite 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6765c4b9fa4637dafaac36da47cd8adf18652cd0d38804ddcd8641b851669f12
-  data.tar.gz: 3a3b27ad8b9fa4319829175995b1d6ea999e9877d537b1316b531247d6bd4b53
+  metadata.gz: 1a7188e92386a13da83abc637b7446d68c485eff8e6e2198a53f88360ac13f02
+  data.tar.gz: f76c576284ba7b90bc671a389cd6e43065079f04ae19567b0e633a147e2b2276
 SHA512:
-  metadata.gz: c2c9a91ccdfe89d997d66e8441d0b130dacc9edeb5fae6a3f949f1e25ff9aec09c41603597dbc7e017e9e3857c838e88182e4b670c220ea376d28934eb45c6e4
-  data.tar.gz: 4f2e69b97a36b68eb84d2c808ede9072b6f333aebe7f2049d16dc7c55e99592604e9e7234b36471d8d84208fec05cfa27b8ce9b942e93d566159209d7fe652d2
+  metadata.gz: b565a159f2aee25115301ae629dcd2e44e844005586c2505e92cd18f75f9845a856c16f8db1c5a309eb249f645ba1e90b6c36ca4e0958f6106f39d0d86f7434a
+  data.tar.gz: 7a34933bf806f8e3fb09351b200698da8d6f5568fefc3054f7ba0591c939dc264b9962c77cd56b6f01e5304b2bb60e5301885f33f34b05bebd54858046cb1e73

data/.rubocop.yml

@@ -5,13 +5,12 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7
   Exclude:
+    - '.git/**/*'
     - 'bin/**/*'
-    - 'db/schema.rb'
     - 'node_modules/**/*'
-    - 'vendor/**/*'
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/dev_suite/version.rb'
+    - 'coverage/**/*'
+    - 'tmp/**/*'
+    - 'log/**/*'
 
 Metrics/LineLength:
   Max: 120

data/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "Shopify.ruby-lsp",
+    "misogi.ruby-rubocop",
+    "KoichiSasada.vscode-rdbg",                
+    "streetsidesoftware.code-spell-checker",
+  ]
+}

data/.vscode/launch.json

@@ -0,0 +1,39 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug all tests",
+      "type": "rdbg",
+      "request": "launch",
+      "useBundler": true,
+      "script": "${workspaceFolder}/bin/rspec",
+      "args": [
+        "--color",
+        "--require",
+        "rspec",
+        "--format",
+        "progress",
+        "${workspaceFolder}/spec"
+      ],
+      "useTerminal": false,
+      "env": { "DEBUG": "true" }
+    },
+    {
+      "name": "Debug current line",
+      "type": "rdbg",
+      "request": "launch",
+      "useBundler": true,
+      "script": "${workspaceFolder}/bin/rspec",
+      "args": [
+        "--color",
+        "--require",
+        "rspec",
+        "--format",
+        "progress",
+        "${file}:${lineNumber}"
+      ],
+      "useTerminal": false,
+      "env": { "DEBUG": "true" }
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+  "[ruby]": {
+    "editor.defaultFormatter": "Shopify.ruby-lsp", // Use the Ruby LSP as the default formatter
+    "editor.formatOnSave": true, // Format files automatically when saving
+    "editor.tabSize": 2, // Use 2 spaces for indentation
+    "editor.insertSpaces": true, // Use spaces and not tabs for indentation
+    "editor.semanticHighlighting.enabled": true, // Enable semantic highlighting
+    "editor.formatOnType": true // Enable formatting while typing
+  },
+  "rubyLsp.enabledFeatures": {
+    "codeActions": true,
+    "diagnostics": true,
+    "documentHighlights": true,
+    "documentLink": true,
+    "documentSymbols": true,
+    "foldingRanges": true,
+    "formatting": true,
+    "hover": true,
+    "inlayHint": true,
+    "onTypeFormatting": true,
+    "selectionRanges": true,
+    "semanticHighlighting": true,
+    "completion": true,
+    "codeLens": true
+  },
+  "rubyLsp.formatter": "rubocop", // Use RuboCop for formatting within Ruby LSP
+  "ruby.rubocop.configFilePath": ".rubocop.yml" // Use the .rubocop.yml file in the root of the project
+}

data/Gemfile

@@ -5,13 +5,18 @@ source "https://rubygems.org"
 # Use the gemspec method to include dependencies specified in the gemspec file
 gemspec
 
+# Additional runtime dependencies
+gem "faraday", "~> 1.4"
+
 # 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
 
 group :development do
+  gem "pry", "~> 0.14"
   gem "rubocop", "~> 1.65", require: false
   gem "rubocop-shopify", "~> 2.15", require: false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dev_suite (0.2.4)
+    dev_suite (0.2.7)
       benchmark (~> 0.1)
       get_process_mem (~> 1.0)
       thor (~> 1.1)
@@ -15,6 +15,29 @@ GEM
     coderay (1.1.3)
     diff-lcs (1.5.1)
     docile (1.4.1)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.2)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     ffi (1.17.0)
     ffi (1.17.0-aarch64-linux-gnu)
     ffi (1.17.0-aarch64-linux-musl)
@@ -32,6 +55,7 @@ GEM
     json (2.7.2)
     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)
       ast (~> 2.4.1)
@@ -43,7 +67,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.4)
+    rexml (3.3.6)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -74,6 +98,7 @@ GEM
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -99,6 +124,7 @@ PLATFORMS
 
 DEPENDENCIES
   dev_suite!
+  faraday (~> 1.4)
   pry (~> 0.14)
   rake (~> 13.0)
   rspec (~> 3.9)

data/README.md

@@ -57,15 +57,13 @@ DevSuite also provides a command-line interface for various utilities. Below are
 ## Features Overview
 
 ### Performance Analysis
+Analyze the performance of Ruby code blocks, capturing metrics like execution time and memory usage.
+
 <details>
   <summary>Show more</summary>
   
-  **Purpose**: Quickly analyze the performance of Ruby code blocks, capturing metrics like execution time and memory usage.
-
   **How to Use**:
   ```ruby
-  require 'dev_suite'
-  
   DevSuite::Performance.analyze(description: "Example Analysis") do
     sum = 0
     1_000_000.times { |i| sum += i }
@@ -88,15 +86,13 @@ DevSuite also provides a command-line interface for various utilities. Below are
 </details>
 
 ### Directory Tree Visualization
+Visualize the file structure of directories and subdirectories to better understand project organization.
+
 <details>
   <summary>Show more</summary>
   
-  **Purpose**: Visualize the file structure of directories and subdirectories to better understand project organization.
-
   **How to Use**:
   ```ruby
-  require 'dev_suite'
-
   # Define the directory path
   base_path = "/path/to/your/directory"
 
@@ -153,6 +149,71 @@ DevSuite also provides a command-line interface for various utilities. Below are
   ```
 </details>
 
+### Request Logging
+Log detailed HTTP requests and responses across different adapters like Net::HTTP and Faraday for debugging and monitoring
+
+<details>
+  <summary>Show more</summary>
+  
+  **How to Use**:
+  ```ruby
+  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::Config.configure do |config|
+    config.adapters = [:net_http]
+    config.settings.set(:log_level, :debug)
+    config.settings.set(:log_headers, true)
+    config.settings.set(:log_cookies, true)
+    config.settings.set(:log_body, true)
+  end
+  ```
+
+  **Configuration Options**:
+  
+  Below is a table describing the general configuration options available:
+
+  | Setting        | Description                                           | Default Value | Example Values                     |
+  |----------------|-------------------------------------------------------|---------------|------------------------------------|
+  | `:adapters`    | List of adapters for which logging is enabled.        | `[:net_http]` | `[:net_http, :faraday]`            |
+
+  **Settings Options**:
+
+  The `settings` key allows you to customize various logging behaviors. Below is a table describing these settings:
+
+  | Setting        | Description                                           | Default Value | Example Values                     |
+  |----------------|-------------------------------------------------------|---------------|------------------------------------|
+  | `:log_level`   | Set the logging level.                                | `:debug`      | `:info`, `:debug`, `:warn`, `:error` |
+  | `:log_headers` | Enable or disable logging of HTTP headers.            | `true`        | `true`, `false`                    |
+  | `:log_cookies` | Enable or disable logging of cookies.                 | `true`        | `true`, `false`                    |
+  | `:log_body`    | Enable or disable logging of HTTP bodies.             | `true`        | `true`, `false`                    |
+
+  **Sample Output**:
+  ```bash
+[DEBUG] 🚀 Net::HTTP Request: GET https://jsonplaceholder.typicode.com/posts
+[DEBUG] 📄 Headers: {"accept-encoding"=>"gzip;q=1.0,deflate;q=0.6,identity;q=0.3", "accept"=>"*/*", "user-agent"=>"Ruby", "host"=>"jsonplaceholder.typicode.com"}
+[DEBUG] 🍪 Cookies: None
+[DEBUG] ✅ Net::HTTP Response: 200 OK
+[DEBUG] 📄 Headers: {"date"=>"Wed, 21 Aug 2024 10:33:59 GMT", "content-type"=>"application/json; charset=utf-8", "transfer-encoding"=>"chunked", "connection"=>"keep-alive", "report-to"=>"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1723379558&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=LYnyHXQQqBH310%2FAbzjH0MN%2BaFoA6Ntqh94a3%2F5J54E%3D\"}]}", "reporting-endpoints"=>"heroku-nel=https://nel.heroku.com/reports?ts=1723379558&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=LYnyHXQQqBH310%2FAbzjH0MN%2BaFoA6Ntqh94a3%2F5J54E%3D", "nel"=>"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}", "x-powered-by"=>"Express", "x-ratelimit-limit"=>"1000", "x-ratelimit-remaining"=>"999", "x-ratelimit-reset"=>"1723379596", "vary"=>"Origin, Accept-Encoding", "access-control-allow-credentials"=>"true", "cache-control"=>"max-age=43200", "pragma"=>"no-cache", "expires"=>"-1", "x-content-type-options"=>"nosniff", "etag"=>"W/\"6b80-Ybsq/K6GwwqrYkAsFxqDXGC7DoM\"", "via"=>"1.1 vegur", "cf-cache-status"=>"HIT", "age"=>"4620", "server"=>"cloudflare", "cf-ray"=>"8b69f7d4ad941fa4-HKG", "alt-svc"=>"h3=\":443\"; ma=86400"}
+[DEBUG] 💻 Response Body: [
+  {
+    "userId": 1,
+    "id": 1,
+    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
+    "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
+  },
+  ...
+]
+  ```
+</details>
+
 ## Development
 
 After checking out the repo, run `bin/setup`for an interactive prompt that will allow you to experiment.

data/bin/rspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/builder/base.rb

@@ -3,7 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Builder
-      class Base
+      class Base < Utils::Construct::Component::Base
         #
         # Recursive method to build the tree
         #

data/lib/dev_suite/directory_tree/builder/builder.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Builder
+      include Utils::Construct::Component::Manager
+
+      require_relative "base"
+
+      register_component(Base)
+    end
+  end
+end

data/lib/dev_suite/directory_tree/builder.rb

@@ -3,18 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Builder
-      require_relative "builder/base"
-
-      class << self
-        def create(type)
-          case type
-          when :base
-            Base.new
-          else
-            raise ArgumentError, "Unknown renderer type: #{type}"
-          end
-        end
-      end
+      require_relative "builder/builder"
     end
   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::Manager
+
+      require_relative "configuration"
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Config
+      class Configuration < Utils::Construct::Config::Base
+        set_default_settings(
+          skip_hidden: false,
+          skip_types: [],
+          max_depth: nil,
+          max_size: 100 * 1024 * 1024, # 100 MB
+        )
+
+        config_attr :builder, default_value: :base, type: :symbol, resolver: :resolve_builder
+        config_attr :renderer, default_value: :simple, type: :symbol, resolver: :resolve_renderer
+        config_attr :visualizer, default_value: :tree, type: :symbol, resolver: :resolve_visualizer
+
+        private
+
+        def resolve_builder(value)
+          Builder.build_component(value)
+        end
+
+        def resolve_renderer(value)
+          Renderer.build_component(value)
+        end
+
+        def resolve_visualizer(value)
+          Visualizer.build_component(value)
+        end
+      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

@@ -2,11 +2,8 @@
 
 module DevSuite
   module DirectoryTree
-    require "pathname"
-
     require_relative "node"
     require_relative "config"
-    require_relative "settings"
     require_relative "renderer"
     require_relative "builder"
     require_relative "visualizer"

data/lib/dev_suite/directory_tree/node/node.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Node
+      require_relative "base"
+      require_relative "file"
+      require_relative "directory"
+      require_relative "permission_denied"
+    end
+  end
+end

data/lib/dev_suite/directory_tree/node.rb

@@ -3,10 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Node
-      require_relative "node/base"
-      require_relative "node/file"
-      require_relative "node/directory"
-      require_relative "node/permission_denied"
+      require_relative "node/node"
     end
   end
 end

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

@@ -3,13 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Renderer
-      class Base
-        attr_reader :settings
-
-        def initialize(settings: Settings.new)
-          @settings = settings
-        end
-
+      class Base < Utils::Construct::Component::Base
         def render
           raise NotImplementedError
         end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Renderer
+      include Utils::Construct::Component::Manager
+
+      require_relative "base"
+      require_relative "simple"
+
+      register_component(Simple)
+    end
+  end
+end

data/lib/dev_suite/directory_tree/renderer.rb

@@ -3,19 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Renderer
-      require_relative "renderer/base"
-      require_relative "renderer/simple"
-
-      class << self
-        def create(type)
-          case type
-          when :simple
-            Simple.new
-          else
-            raise ArgumentError, "Unknown renderer type: #{type}"
-          end
-        end
-      end
+      require_relative "renderer/renderer"
     end
   end
 end

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

@@ -3,7 +3,7 @@
 module DevSuite
   module DirectoryTree
     module Visualizer
-      class Base
+      class Base < Utils::Construct::Component::Base
         def visualize(path)
           raise NotImplementedError, "You must implement #{self.class}##{__method}"
         end

data/lib/dev_suite/directory_tree/visualizer/visualizer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Visualizer
+      include Utils::Construct::Component::Manager
+
+      require "pathname"
+
+      require_relative "base"
+      require_relative "tree"
+
+      register_component(Tree)
+    end
+  end
+end