dev_suite 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde5663cbb9add03d1db18d4b31fffba0049d8d4f49e5e6bcac7d5d72c6933a2
-  data.tar.gz: d37a1514954b871e610f07942556581f0c68ff83ce35f8f408e35adbabaeee3b
+  metadata.gz: d90d0f33e4d0651dbc5ed388a62c7c0b3a665cb27db805631d8771245b21129e
+  data.tar.gz: e87b028766648877eea33d3c2910d3879510a50d4425fd9b19bf96212cb141a7
 SHA512:
-  metadata.gz: 89a013a696f477509da2adc76551badd312dbe73f6ca94440c57384e6a749e0327a4d9a8d9c2262eab7da4dd0ac431656f163e5f7df1068276397c92d641d9a9
-  data.tar.gz: 6067472079ddfdb69796f2fa34727e44dd8bc8e39c825748aaad8d138640960796bbc15262e0e0d845bfe5b53838d55a8d84208aa89bf6d685f8264e5a5dc2c8
+  metadata.gz: c7a4fdb6138b2c9e75bafa923f095479827d58c229fdc60f2ae8c2b5e2a6a04f8e39c6ed27cf26ab3c53a62f606c5931c851698c1b577f6bdb1bad45289b344e
+  data.tar.gz: 1d10bd660e02d4100ee58fb7607626cfaf2ef714811a9407d25ae12f9fe71ae3ed9fd36d8b21de8bdba6b288223ed9a8b58ae22deb6e3ac297d24692e90ca86e

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0  # Specify your project's Ruby version
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: |
+          bundle exec rspec
+
+      - name: Upload coverage to Code Climate
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+          bundle exec rspec
+          ./cc-test-reporter after-build --exit-code $?

data/Gemfile

@@ -2,11 +2,18 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in dev_suite.gemspec
+# Use the gemspec method to include dependencies specified in the gemspec file
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.9"
-gem "rubocop", "~> 1.65", require: false
-gem "rubocop-shopify", "~> 2.15", require: false
-gem "pry", "~> 0.14"
+# 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 "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.3)
+    dev_suite (0.2.5)
       benchmark (~> 0.1)
       get_process_mem (~> 1.0)
       thor (~> 1.1)
@@ -14,6 +14,7 @@ GEM
     bigdecimal (3.1.8)
     coderay (1.1.3)
     diff-lcs (1.5.1)
+    docile (1.4.1)
     ffi (1.17.0)
     ffi (1.17.0-aarch64-linux-gnu)
     ffi (1.17.0-aarch64-linux-musl)
@@ -73,6 +74,12 @@ GEM
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     strscan (3.1.0)
     thor (1.3.1)
     unicode-display_width (2.5.0)
@@ -97,6 +104,7 @@ DEPENDENCIES
   rspec (~> 3.9)
   rubocop (~> 1.65)
   rubocop-shopify (~> 2.15)
+  simplecov (~> 0.21)
 
 BUNDLED WITH
    2.5.17

data/README.md

@@ -2,7 +2,8 @@
 
 [![Gem Version](https://img.shields.io/gem/v/dev_suite?color=blue)](https://rubygems.org/gems/dev_suite)
 [![Gem Downloads](https://img.shields.io/gem/dt/dev_suite?color=blue)](https://rubygems.org/gems/dev_suite)
-[![Code Climate](https://codeclimate.com/github/patrick204nqh/dev_suite/badges/gpa.svg)](https://codeclimate.com/github/patrick204nqh/dev_suite)
+[![Maintainability](https://api.codeclimate.com/v1/badges/fd83689d39e0f24663fa/maintainability)](https://codeclimate.com/github/patrick204nqh/dev_suite/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/fd83689d39e0f24663fa/test_coverage)](https://codeclimate.com/github/patrick204nqh/dev_suite/test_coverage)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=patrick204nqh_dev_suite&metric=alert_status)](https://sonarcloud.io/summary/overall?id=patrick204nqh_dev_suite)
 [![Dependencies Status](https://badges.depfu.com/badges/84fefb47a5b99ea19afd20a2aae22e3e/overview.svg)](https://depfu.com/github/patrick204nqh/dev_suite?project_id=44065)
 [![Known Vulnerabilities](https://snyk.io/test/github/patrick204nqh/dev_suite/badge.svg)](https://snyk.io/test/github/patrick204nqh/dev_suite)
@@ -107,9 +108,19 @@ DevSuite also provides a command-line interface for various utilities. Below are
   DevSuite also provides a command-line interface for directory tree visualization. Use the following command to print the directory tree of the specified path:
 
   ```sh
-  $ devsuite tree [PATH]
+  $ devsuite tree [PATH] [OPTIONS]
   ```
 
+  **CLI Options**:
+  
+  Below is a table describing the available options for the `devsuite tree` command:
+
+  | Option          | Description                                      | Example Usage                                  |
+  |-----------------|--------------------------------------------------|------------------------------------------------|
+  | `--depth`, `-d` | Limit the depth of the directory tree displayed. | `$ devsuite tree /path --depth 2`              |
+  | `--skip-hidden` | Skip hidden files and directories.               | `$ devsuite tree /path --skip-hidden`          |
+  | `--skip-types`  | Exclude files of specific types.                 | `$ devsuite tree /path --skip-types .log .tmp` |
+
   **Configuration Guide**:
   Customize the visualization by setting configuration options:
   ```ruby
@@ -142,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

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  # Runtime dependencies
   spec.add_dependency("benchmark", "~> 0.1")
   spec.add_dependency("get_process_mem", "~> 1.0")
   spec.add_dependency("thor", "~> 1.1")

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

@@ -4,36 +4,6 @@ module DevSuite
   module CLI
     module Commands
       class Base < Thor
-        no_commands do
-          # Log message to console
-          def log(message, level: :info)
-            case level
-            when :info
-              puts "[INFO] #{message}"
-            when :warn
-              puts "[WARNING] #{message}"
-            when :error
-              puts "[ERROR] #{message}"
-            when :debug
-              puts "[DEBUG] #{message}" if ENV["DEBUG_MODE"]
-            end
-          end
-
-          # Handle common errors
-          def handle_error(error)
-            log("Error: #{error.message}", level: :error)
-            exit(1)
-          end
-
-          # Default method to load configuration
-          def load_config(file)
-            YAML.load_file(file)
-          rescue Errno::ENOENT
-            log("Configuration file not found: #{file}", level: :error)
-            exit(1)
-          end
-        end
-
         desc "execute", "Execute the command"
         def execute
           raise NotImplementedError

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

@@ -5,14 +5,35 @@ module DevSuite
     module Commands
       class Tree < Base
         desc "visualize PATH", "Visualize the directory structure at given PATH"
-        def execute(path)
-          log("Starting visualization for: #{path}")
-          begin
-            # Assume visualize_path is a method that can raise exceptions
-            DirectoryTree.visualize(path)
-            log("Visualization complete.")
-          rescue StandardError => e
-            handle_error(e)
+        def execute(path, options: {})
+          Utils::Logger.log("Starting visualization for: #{path}", emoji: :start)
+
+          apply_configure(options)
+          visualize(path)
+
+          Utils::Logger.log("Visualization complete!", emoji: :success)
+        rescue StandardError => e
+          Utils::ErrorHandler.handle_error(e)
+        end
+
+        private
+
+        def visualize(path)
+          DirectoryTree.visualize(path)
+        end
+
+        def apply_configure(options)
+          option_config_mapping = {
+            depth: :max_depth,
+            skip_hidden: :skip_hidden,
+            skip_types: :skip_types,
+          }
+
+          DirectoryTree::Config.configure do |config|
+            option_config_mapping.each do |option_key, config_key|
+              value = options[option_key]
+              config.settings.set(config_key, value) if value
+            end
           end
         end
       end

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

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

data/lib/dev_suite/cli/main.rb

@@ -4,8 +4,15 @@ module DevSuite
   module CLI
     class Main < Thor
       desc "tree DIRECTORY", "Prints the directory tree"
-      def tree(directory)
-        execute_command(Commands::Tree, directory)
+      method_option :depth, aliases: "-d", type: :numeric, desc: "Limit the depth of the directory tree displayed"
+      method_option :skip_hidden, type: :boolean, default: false, desc: "Skip hidden files and directories"
+      method_option :skip_types,
+        type: :array,
+        default: [],
+        banner: "TYPE1 TYPE2",
+        desc: "Exclude files of specific types"
+      def tree(path = ".")
+        execute_command(Commands::Tree, path, options: options)
       end
 
       desc "version", "Displays the version of the dev_suite gem"
@@ -15,14 +22,10 @@ module DevSuite
 
       private
 
-      def execute_command(command_class, *args)
-        command_class.new.execute(*args)
+      def execute_command(command_class, *args, **kargs)
+        command_class.new.execute(*args, **kargs)
       rescue StandardError => e
-        handle_error(e)
-      end
-
-      def handle_error(error)
-        puts "An error occurred: #{error.message}"
+        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,17 +2,8 @@
 
 module DevSuite
   module DirectoryTree
-    class Config
-      include Utils::ConfigTools::Configuration
-
-      attr_reader :settings, :builder, :renderer
-
-      def initialize(settings: {}, builder: :base, renderer: :simple)
-        @settings = Settings.new(settings)
-        @builder = Builder.create(builder)
-        @renderer = Renderer.create(renderer)
-        freeze # Make the instance of this class immutable as well
-      end
+    module Config
+      require_relative "config/config"
     end
   end
 end

data/lib/dev_suite/directory_tree/directory_tree.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    require "pathname"
+
+    require_relative "node"
+    require_relative "config"
+    require_relative "renderer"
+    require_relative "builder"
+    require_relative "visualizer"
+
+    class << self
+      def visualize(path)
+        visualizer = Config.configuration.visualizer
+        visualizer.visualize(path)
+      end
+    end
+  end
+end

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/directory_tree/renderer/simple.rb

@@ -40,15 +40,15 @@ module DevSuite
         end
 
         def hidden_file_skipped?(node)
-          settings.skip_hidden? && node.hidden?
+          settings.get(:skip_hidden) && node.hidden?
         end
 
         def filetype_skipped?(node)
-          node.file? && settings.skip_types.include?(::File.extname(node.name))
+          node.file? && settings.get(:skip_types).include?(::File.extname(node.name))
         end
 
         def exceeds_max_depth?(depth)
-          max_depth = settings.max_depth
+          max_depth = settings.get(:max_depth)
           max_depth && depth > max_depth
         end
 

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Visualizer
+      class Base
+        def visualize(path)
+          raise NotImplementedError, "You must implement #{self.class}##{__method}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    module Visualizer
+      class Tree < Base
+        # Visualizes the directory tree
+        # @param path [String] The base path of the directory
+        def visualize(path)
+          path = Pathname.new(path)
+          validate_path!(path)
+          validate_size!(path)
+
+          root = build_root_node(path)
+          output = render_output(root)
+
+          puts output
+        end
+
+        private
+
+        def validate_path!(path)
+          raise ArgumentError, "Invalid path" unless path.exist?
+        end
+
+        def validate_size!(path)
+          config = Config.configuration
+          max_size = config.settings.get(:max_size)
+          raise ArgumentError, "Directory too large to render" if directory_size(path) > max_size
+        end
+
+        def directory_size(path)
+          path.children.reduce(0) do |size, child|
+            size + (child.directory? ? directory_size(child) : child.size)
+          end
+        end
+
+        def build_root_node(path)
+          config = Config.configuration
+          config.builder.build(path)
+        end
+
+        def render_output(root)
+          config = Config.configuration
+          config.renderer.render(node: root)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/directory_tree/visualizer.rb

@@ -2,20 +2,21 @@
 
 module DevSuite
   module DirectoryTree
-    class Visualizer
-      # Visualizes the directory tree
-      # @param path [String] The base path of the directory
-      def visualize(path)
-        root = Config.configuration.builder.build(Pathname.new(path))
-        renderer = Config.configuration.renderer
-        puts renderer.render(node: root)
-      end
-    end
+    module Visualizer
+      require "pathname"
+
+      require_relative "visualizer/base"
+      require_relative "visualizer/tree"
 
-    class << self
-      def visualize(path)
-        visualizer = Visualizer.new
-        visualizer.visualize(path)
+      class << self
+        def create(type)
+          case type
+          when :tree
+            Tree.new
+          else
+            raise ArgumentError, "Unknown renderer type: #{type}"
+          end
+        end
       end
     end
   end

data/lib/dev_suite/directory_tree.rb

@@ -2,13 +2,6 @@
 
 module DevSuite
   module DirectoryTree
-    require "pathname"
-
-    require_relative "directory_tree/node"
-    require_relative "directory_tree/config"
-    require_relative "directory_tree/settings"
-    require_relative "directory_tree/renderer"
-    require_relative "directory_tree/builder"
-    require_relative "directory_tree/visualizer"
+    require_relative "directory_tree/directory_tree"
   end
 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,16 +2,8 @@
 
 module DevSuite
   module Performance
-    class Config
-      include Utils::ConfigTools::Configuration
-
-      attr_reader :profilers, :reportor
-
-      def initialize(profilers: [:execution_time, :memory], reportor: :simple)
-        @profilers = Profiler.create_multiple(profilers)
-        @reportor = Reportor.create(reportor)
-        freeze # Make the instance of this class immutable
-      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"