dev_suite 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde5663cbb9add03d1db18d4b31fffba0049d8d4f49e5e6bcac7d5d72c6933a2
-  data.tar.gz: d37a1514954b871e610f07942556581f0c68ff83ce35f8f408e35adbabaeee3b
+  metadata.gz: 6765c4b9fa4637dafaac36da47cd8adf18652cd0d38804ddcd8641b851669f12
+  data.tar.gz: 3a3b27ad8b9fa4319829175995b1d6ea999e9877d537b1316b531247d6bd4b53
 SHA512:
-  metadata.gz: 89a013a696f477509da2adc76551badd312dbe73f6ca94440c57384e6a749e0327a4d9a8d9c2262eab7da4dd0ac431656f163e5f7df1068276397c92d641d9a9
-  data.tar.gz: 6067472079ddfdb69796f2fa34727e44dd8bc8e39c825748aaad8d138640960796bbc15262e0e0d845bfe5b53838d55a8d84208aa89bf6d685f8264e5a5dc2c8
+  metadata.gz: c2c9a91ccdfe89d997d66e8441d0b130dacc9edeb5fae6a3f949f1e25ff9aec09c41603597dbc7e017e9e3857c838e88182e4b670c220ea376d28934eb45c6e4
+  data.tar.gz: 4f2e69b97a36b68eb84d2c808ede9072b6f333aebe7f2049d16dc7c55e99592604e9e7234b36471d8d84208fec05cfa27b8ce9b942e93d566159209d7fe652d2

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,16 @@
 
 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 "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.4)
       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

data/dev_suite.gemspec

@@ -29,7 +29,12 @@ 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")
+
+  # 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,35 +4,7 @@ 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
+        include ErrorHandler
 
         desc "execute", "Execute the command"
         def execute

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: {})
+          Logger.log("Starting visualization for: #{path}", emoji: :start)
+
+          apply_configure(options)
+          visualize(path)
+
+          Logger.log("Visualization complete!", emoji: :success)
+        rescue StandardError => e
+          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}")
+          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}"
+        ErrorHandler.handle_error(e)
       end
     end
   end

data/lib/dev_suite/directory_tree/config.rb

@@ -5,13 +5,38 @@ module DevSuite
     class Config
       include Utils::ConfigTools::Configuration
 
-      attr_reader :settings, :builder, :renderer
+      # 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
 
-      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
+      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
     end
   end

data/lib/dev_suite/directory_tree/directory_tree.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module DirectoryTree
+    require "pathname"
+
+    require_relative "node"
+    require_relative "config"
+    require_relative "settings"
+    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/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/settings.rb

@@ -10,20 +10,9 @@ module DevSuite
           skip_hidden: false,
           skip_types: [],
           max_depth: nil,
+          max_size: 100 * 1024 * 1024, # 100 MB
         }
       end
-
-      def skip_hidden?
-        get(:skip_hidden)
-      end
-
-      def skip_types
-        get(:skip_types)
-      end
-
-      def max_depth
-        get(:max_depth)
-      end
     end
   end
 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/emoji.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Emoji
+    # A frozen hash that contains all the emojis used in the application.
+    EMOJIS = {
+      start: "🚀",
+      success: "✅",
+      error: "🚨❌",
+      retry: "💥",
+      info: "ℹ️",
+      warning: "⚠️",
+      note: "📝",       # For notes or annotations
+      tip: "💡",        # For tips or helpful hints
+      important: "❗",  # For important information
+      caution: "⚠️", # For warnings or cautions
+      document: "📄",   # For representing documents or files
+      code: "💻",       # For code or technical content
+      update: "🔄",     # For updates or changes
+      bug: "🐞",        # For bugs or issues
+      fix: "🔧",        # For fixes or repairs
+    }.freeze
+
+    class << self
+      # Returns the emoji corresponding to the given key.
+      # @param key [Symbol] the key to look up the emoji
+      # @return [String] the corresponding emoji or an empty string if not found
+      def get(key)
+        EMOJIS[key] || ""
+      end
+    end
+  end
+end

data/lib/dev_suite/error_handler.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module ErrorHandler
+    extend self # This makes all instance methods behave like class methods
+
+    def handle_error(error)
+      Logger.log(
+        "Oops! An error occurred: #{error.message}",
+        level: :error,
+        emoji: :error,
+      )
+      Logger.log(
+        "For more information, please refer to the README: " \
+          "https://github.com/patrick204nqh/dev_suite",
+        level: :error,
+        emoji: :document,
+      )
+      # exit(1)
+    end
+  end
+end

data/lib/dev_suite/logger.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Logger
+    LOG_DETAILS = {
+      info: { prefix: "[INFO]", color: :green },
+      warn: { prefix: "[WARNING]", color: :yellow },
+      error: { prefix: "[ERROR]", color: :red },
+      debug: { prefix: "[DEBUG]", color: :blue },
+    }.freeze
+
+    class << self
+      # Logs a message with an optional emoji and specified log level.
+      #
+      # @param message [String] The message to log.
+      # @param level [Symbol] The log level (:info, :warn, :error, :debug).
+      # @param emoji [String, Symbol] Optional emoji to prepend to the message.
+      def log(message, level: :info, emoji: nil)
+        emoji_icon = resolve_emoji(emoji)
+        formatted_message = format_message("#{emoji_icon} #{message}", level)
+        output_log(formatted_message)
+      end
+
+      private
+
+      # Resolves the emoji, either from a symbol or directly as a string.
+      #
+      # @param emoji [String, Symbol, nil] The emoji or its symbol key.
+      # @return [String] The resolved emoji or an empty string if none is provided.
+      def resolve_emoji(emoji)
+        return "" unless emoji
+
+        emoji.is_a?(Symbol) ? Emoji.get(emoji) : emoji
+      end
+
+      # Formats the log message with the appropriate prefix and color.
+      #
+      # @param message [String] The message to format.
+      # @param level [Symbol] The log level (:info, :warn, :error, :debug).
+      # @return [String] The formatted log message.
+      def format_message(message, level)
+        details = LOG_DETAILS[level]
+        raise ArgumentError, "Invalid log level: #{level}" unless details
+
+        Utils::Color.colorize("#{details[:prefix]} #{message}", color: details[:color])
+      end
+
+      # Outputs the formatted log message to the console.
+      #
+      # @param formatted_message [String] The message to output.
+      def output_log(formatted_message)
+        puts formatted_message if formatted_message
+      end
+    end
+  end
+end

data/lib/dev_suite/performance/config.rb

@@ -5,12 +5,32 @@ module DevSuite
     class Config
       include Utils::ConfigTools::Configuration
 
-      attr_reader :profilers, :reportor
+      # Define configuration attributes
+      config_attr :profilers, default_value: [:execution_time, :memory]
+      config_attr :reportor, default_value: :simple
 
-      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
+      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
     end
   end

data/lib/dev_suite/utils/config_tools/configuration.rb

@@ -8,31 +8,124 @@ module DevSuite
         class << self
           def included(base)
             base.extend(ClassMethods)
+            base.include(InstanceMethods)
           end
         end
 
         module ClassMethods
-          #
-          # Provide global access to a single instance of Config
-          #
+          # Provides global access to a single instance of the configuration class
+          # @return [Object] The singleton configuration instance
           def configuration
             @configuration ||= new
           end
 
-          #
-          # Allow block-based configuration
-          #
+          # Allows block-based configuration
+          # Example usage:
+          #   ConfigClass.configure do |config|
+          #     config.attr_name = value
+          #   end
           def configure
             yield(configuration)
           rescue StandardError => e
-            handle_configuration_error(e)
-            raise
+            ErrorHandler.handle_error(e)
+          end
+
+          # Defines a configuration attribute with an optional default value
+          # This method automatically creates getter and setter methods for the attribute
+          #
+          # @param attr_name [Symbol] The name of the attribute
+          # @param default_value [Object] The default value for the attribute
+          def config_attr(attr_name, default_value: nil)
+            config_attrs[attr_name] = default_value
+
+            # Getter method for the attribute
+            define_method(attr_name) do
+              instance_variable_get("@#{attr_name}")
+            end
+
+            # Setter method for the attribute with validation and resolution
+            define_method("#{attr_name}=") do |value|
+              validate_attr!(attr_name, value)
+              instance_variable_set("@#{attr_name}", resolve_attr(attr_name, value))
+            end
           end
 
+          # Stores configuration attributes and their default values
+          # @return [Hash] A hash of attribute names and their default values
+          def config_attrs
+            @config_attrs ||= {}
+          end
+        end
+
+        # Module for instance-level methods
+        module InstanceMethods
           private
 
-          def handle_configuration_error(error)
-            puts "Configuration error: #{error.message}"
+          # Initializes configuration attributes with provided or default values
+          # This method is called automatically during object initialization
+          #
+          # @param options [Hash] A hash of attribute names and their values
+          def initialize(**options)
+            initialize_attributes(options)
+          end
+
+          # Sets up each attribute with either the provided value or the default value
+          #
+          # @param options [Hash] A hash of attribute names and their values
+          def initialize_attributes(options)
+            self.class.config_attrs.each do |attr_name, default_value|
+              value = options.fetch(attr_name, default_value)
+              send("#{attr_name}=", value)
+            end
+          end
+
+          # Validates an attribute's value based on its type
+          # Override this method in the including class to add custom validation logic
+          #
+          # @param attr [Symbol] The name of the attribute
+          # @param value [Object] The value to validate
+          def validate_attr!(attr, value)
+            raise ArgumentError, "Unknown attribute: #{attr}" unless self.class.config_attrs.key?(attr)
+            raise ArgumentError, "Invalid #{attr} value: #{value}" if value.nil?
+
+            # Override in including class to add custom validation logic
+          end
+
+          # Validates that an attribute's value is a Hash
+          #
+          # @param attr [Symbol] The name of the attribute
+          # @param value [Object] The value to validate
+          def validate_hash!(attr, value)
+            raise ArgumentError, "Invalid #{attr} value: expected a Hash" unless value.is_a?(Hash)
+          end
+
+          # Validates that an attribute's value is a Symbol
+          #
+          # @param attr [Symbol] The name of the attribute
+          # @param value [Object] The value to validate
+          def validate_symbol!(attr, value)
+            raise ArgumentError, "Invalid #{attr} value: expected a Symbol" unless value.is_a?(Symbol)
+          end
+
+          # Validates that an attribute's value is an Array
+          #
+          # @param attr [Symbol] The name of the attribute
+          # @param value [Object] The value to validate
+          def validate_array!(attr, value)
+            raise ArgumentError, "Invalid #{attr} value: expected an Array" unless value.is_a?(Array)
+          end
+
+          # Resolves the value of an attribute, especially if it requires
+          # converting a symbol to an object. Override in the including class.
+          #
+          # @param _attr [Symbol] The name of the attribute
+          # @param value [Object] The value to resolve
+          # @return [Object] The resolved value
+          def resolve_attr(attr, value)
+            raise ArgumentError, "Unknown attribute: #{attr}" unless self.class.config_attrs.key?(attr)
+
+            # Override in including class to resolve symbols to objects
+            value
           end
         end
       end

data/lib/dev_suite/utils/config_tools/settings.rb

@@ -32,14 +32,6 @@ module DevSuite
             end
           end
 
-          def apply
-            #
-            # Implement logic to apply settings in the including class
-            # TODO: need to review this method
-            #
-            raise NotImplementedError, "#{self.class} must implement the #apply method"
-          end
-
           def reset!
             @settings = default_settings
           end

data/lib/dev_suite/version.rb

@@ -1,3 +1,3 @@
 module DevSuite
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/dev_suite.rb

@@ -2,11 +2,13 @@
 
 module DevSuite
   require_relative "dev_suite/version"
-  require_relative "dev_suite/cli"
+  require_relative "dev_suite/emoji"
+  require_relative "dev_suite/logger"
+  require_relative "dev_suite/error_handler"
   require_relative "dev_suite/utils"
+  require_relative "dev_suite/cli"
   require_relative "dev_suite/performance"
   require_relative "dev_suite/directory_tree"
 
   class Error < StandardError; end
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dev_suite
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Huy Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 description: This gem provides a suite of utilities for developers to enhance their
   productivity.
 email:
@@ -61,6 +89,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -87,6 +116,7 @@ files:
 - lib/dev_suite/directory_tree/builder.rb
 - lib/dev_suite/directory_tree/builder/base.rb
 - lib/dev_suite/directory_tree/config.rb
+- lib/dev_suite/directory_tree/directory_tree.rb
 - lib/dev_suite/directory_tree/node.rb
 - lib/dev_suite/directory_tree/node/base.rb
 - lib/dev_suite/directory_tree/node/directory.rb
@@ -97,6 +127,11 @@ files:
 - lib/dev_suite/directory_tree/renderer/simple.rb
 - lib/dev_suite/directory_tree/settings.rb
 - lib/dev_suite/directory_tree/visualizer.rb
+- lib/dev_suite/directory_tree/visualizer/base.rb
+- lib/dev_suite/directory_tree/visualizer/tree.rb
+- lib/dev_suite/emoji.rb
+- lib/dev_suite/error_handler.rb
+- lib/dev_suite/logger.rb
 - lib/dev_suite/performance.rb
 - lib/dev_suite/performance/analyzer.rb
 - lib/dev_suite/performance/config.rb