dev_suite 0.2.2 → 0.2.4

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.2"
+  VERSION = "0.2.4"
 end

data/lib/dev_suite.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
-require "dev_suite/version"
-require "dev_suite/utils"
-require "dev_suite/performance"
-require "dev_suite/directory_tree"
-
 module DevSuite
+  require_relative "dev_suite/version"
+  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.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Huy Nguyen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark
@@ -30,22 +30,66 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
 - patrick204nqh@gmail.com
-executables: []
+executables:
+- devsuite
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -60,11 +104,19 @@ files:
 - bin/console
 - bin/setup
 - dev_suite.gemspec
+- exe/devsuite
 - lib/dev_suite.rb
+- lib/dev_suite/cli.rb
+- lib/dev_suite/cli/commands.rb
+- lib/dev_suite/cli/commands/base.rb
+- lib/dev_suite/cli/commands/tree.rb
+- lib/dev_suite/cli/commands/version.rb
+- lib/dev_suite/cli/main.rb
 - lib/dev_suite/directory_tree.rb
 - 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
@@ -75,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
@@ -82,10 +139,14 @@ files:
 - lib/dev_suite/performance/data/memory_usage.rb
 - lib/dev_suite/performance/profiler.rb
 - lib/dev_suite/performance/profiler/base.rb
-- lib/dev_suite/performance/profiler/benchmark.rb
+- lib/dev_suite/performance/profiler/execution_time.rb
 - lib/dev_suite/performance/profiler/memory.rb
+- lib/dev_suite/performance/profiler_manager.rb
 - lib/dev_suite/performance/reportor.rb
 - lib/dev_suite/performance/reportor/base.rb
+- lib/dev_suite/performance/reportor/helpers.rb
+- lib/dev_suite/performance/reportor/helpers/stat_mappings.rb
+- lib/dev_suite/performance/reportor/helpers/table_builder.rb
 - lib/dev_suite/performance/reportor/simple.rb
 - lib/dev_suite/utils.rb
 - lib/dev_suite/utils/color.rb

data/lib/dev_suite/performance/profiler/benchmark.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module DevSuite
-  module Performance
-    module Profiler
-      class Benchmark < Base
-        def run(&block)
-          ::Benchmark.measure do
-            block.call
-          end
-        end
-      end
-    end
-  end
-end