dev_suite 0.2.4 → 0.2.5

data/lib/dev_suite/utils/construct/config/settings/base.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Settings
+          class Base
+            def initialize(settings = {})
+              @default_settings = settings
+              @settings = merge_settings(@default_settings, settings)
+            end
+
+            def set(*keys, value)
+              key_path = normalize_keys(keys)
+              last_key = key_path.pop
+              target = key_path.each_with_object(@settings) do |key, nested|
+                nested[key] ||= {}
+              end
+              target[last_key] = value
+            end
+
+            def get(*keys)
+              key_path = normalize_keys(keys)
+              key_path.reduce(@settings) do |nested, key|
+                nested.is_a?(Hash) ? nested[key] : nil
+              end
+            end
+
+            def reset!
+              @settings = @default_settings
+            end
+
+            private
+
+            def normalize_keys(keys)
+              key_path = keys.flatten
+              if key_path.size == 1 && key_path.first.is_a?(String)
+                key_path.first.to_s.split(".").map(&:to_sym)
+              else
+                key_path.map(&:to_sym)
+              end
+            end
+
+            def merge_settings(defaults, overrides)
+              defaults.merge(overrides) do |_key, oldval, newval|
+                if oldval.is_a?(Hash) && newval.is_a?(Hash)
+                  merge_settings(oldval, newval)
+                else
+                  newval
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/construct/config/settings/manager.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Settings
+          module Manager
+            class << self
+              def included(base)
+                base.extend(ClassMethods)
+              end
+            end
+
+            module ClassMethods
+              # Ensure that default configuration attributes are applied to subclasses.
+              def inherited(subclass)
+                subclass.set_default_settings
+                super
+              end
+
+              # Define default settings for the class.
+              def set_default_settings(settings = {})
+                config_attr(:settings, default_value: settings, type: :hash, resolver: :resolve_settings)
+              end
+            end
+
+            private
+
+            def resolve_settings(value)
+              Base.new(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/construct/config/settings/settings.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Settings
+          require_relative "base"
+          require_relative "manager"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/construct/config/settings.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Settings
+          require_relative "settings/settings"
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/construct/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        require_relative "config/config"
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/construct/construct.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      require_relative "config"
+    end
+  end
+end

data/lib/dev_suite/utils/construct.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      # The Construct module serves as a namespace for reusable constructs that
+      # provide foundational utilities, such as configuration management, which
+      # can be included in other modules throughout the DevSuite framework.
+      #
+      # This module centralizes shared functionality to promote code reuse,
+      # maintainability, and consistency across different modules.
+
+      require_relative "construct/construct"
+    end
+  end
+end

data/lib/dev_suite/utils/emoji.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Emoji
+      # Status-related emojis
+      STATUS = {
+        start: "🚀",
+        success: "✅",
+        error: "🚨❌",
+        retry: "💥",
+        warning: "⚠️", # For warnings
+        caution: "🟡", # For caution or proceed with care
+      }.freeze
+
+      # Action-related emojis
+      ACTIONS = {
+        update: "🔄",     # For updates or changes
+        fix: "🔧",        # For fixes or repairs
+        bug: "🐞",        # For bugs or issues
+        code: "💻",       # For code or technical content
+      }.freeze
+
+      # Notification-related emojis
+      NOTIFICATIONS = {
+        info: "ℹ️",
+        important: "❗",
+        note: "📝",       # For notes or annotations
+        tip: "💡",        # For tips or helpful hints
+      }.freeze
+
+      # Resource-related emojis
+      RESOURCES = {
+        document: "📄",   # For representing documents or files
+        network: "🌐",    # For network-related logs
+        database: "💾",   # For database-related logs
+        cache: "🗄️",     # For cache-related logs
+        file: "📁",       # For file-related logs
+        cookie: "🍪",     # For cookie-related logs
+        header: "📑",     # For header-related logs
+        request: "📤",    # For request-related logs
+        response: "📥",   # For response-related logs
+      }.freeze
+
+      DEFAULT_EMOJI = "❓"
+
+      EMOJIS = STATUS.merge(ACTIONS).merge(NOTIFICATIONS).merge(RESOURCES).freeze
+
+      class << self
+        # Returns the emoji corresponding to the given key.
+        # @param key [Symbol] the key to look up the emoji
+        # @param default [String] the default emoji if the key is not found
+        # @return [String] the corresponding emoji or the default emoji
+        def get(key, default: DEFAULT_EMOJI)
+          EMOJIS[key] || default
+        end
+
+        # Returns all emojis categorized by their purpose.
+        # @return [Hash] a hash containing all emojis organized by categories.
+        def all
+          {
+            status: STATUS,
+            actions: ACTIONS,
+            notifications: NOTIFICATIONS,
+            resources: RESOURCES,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/error_handler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module ErrorHandler
+      extend self # This makes all instance methods behave like class methods
+
+      def handle_error(error)
+        Utils::Logger.log(
+          "Oops! An error occurred: #{error.message}",
+          level: :error,
+          emoji: :error,
+        )
+        Utils::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
+end

data/lib/dev_suite/utils/file_loader/config/config.rb

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

data/lib/dev_suite/utils/file_loader/config/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Config
+        class Configuration < BaseConfiguration
+          config_attr :loaders, default_value: [:text, :json, :yaml], type: :array
+
+          register_hook :after_initialize do
+            setup_registry
+          end
+
+          # Expose the registry as a read-only attribute
+          attr_reader :registry
+
+          # Setup the registry based on the current loaders
+          def setup_registry
+            @registry = LoaderRegistry.new
+            update_registry(loaders)
+          end
+
+          # Update the registry with the provided loaders
+          def update_registry(loaders)
+            @registry ||= LoaderRegistry.new
+            @registry.clear # Clear the existing registry
+            Loader.registry_loaders(@registry, loaders)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Config
+        require_relative "config/config"
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/file_loader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      require "pathname"
+      require "json"
+      require "yaml"
+
+      require_relative "loader"
+      require_relative "loader_registry"
+      require_relative "loader_manager"
+      require_relative "config"
+
+      class << self
+        def load(path)
+          loader = LoaderManager.new
+          loader.load(path)
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Loader
+        class Base
+          class << self
+            def extensions
+              raise NotImplementedError, "You must implement the extensions method"
+            end
+          end
+
+          def load(_path)
+            raise NotImplementedError, "You must implement the load method"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader/json.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Loader
+        class Json < Base
+          class << self
+            def extensions
+              ["json"]
+            end
+          end
+
+          def load(path)
+            ::JSON.parse(::File.read(path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader/text.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Loader
+        class Text < Base
+          class << self
+            def extensions
+              ["txt"]
+            end
+          end
+
+          def load(path)
+            ::File.read(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader/yaml.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Loader
+        class Yaml < Base
+          class << self
+            def extensions
+              ["yml", "yaml"]
+            end
+          end
+
+          def load(path, safe: true)
+            validate_file_existence!(path)
+            parse_yaml_file(path, safe)
+          rescue ::Psych::SyntaxError => e
+            handle_yaml_parsing_error(path, e)
+          end
+
+          private
+
+          def validate_file_existence!(path)
+            raise "File not found: #{path}" unless ::File.exist?(path)
+          end
+
+          def parse_yaml_file(path, safe)
+            safe ? ::YAML.safe_load_file(path) : ::YAML.load_file(path)
+          end
+
+          def handle_yaml_parsing_error(path, error)
+            raise "YAML parsing error in file #{path}: #{error.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      module Loader
+        require_relative "loader/base"
+        require_relative "loader/text"
+        require_relative "loader/json"
+        require_relative "loader/yaml"
+
+        class << self
+          def registry_loaders(registry, loader_symbols)
+            loader_classes = map_loaders(loader_symbols)
+            loader_classes.each do |loader|
+              registry.register(loader)
+            end
+            registry
+          end
+
+          private
+
+          def map_loaders(loader_symbols)
+            loader_symbols.map do |symbol|
+              case symbol
+              when :json
+                Loader::Json
+              when :text
+                Loader::Text
+              when :yaml
+                Loader::Yaml
+              else
+                raise "Unknown loader: #{symbol}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader_manager.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      class LoaderManager
+        def load(path)
+          loader = find_loader_for(path)
+          loader.load(path)
+        end
+
+        private
+
+        def find_loader_for(path)
+          extension = extract_extension(path)
+          loader = registry.find_loader(extension)
+          raise LoaderNotFoundError, "No loader registered for #{extension}" unless loader
+
+          loader
+        end
+
+        def extract_extension(path)
+          ::File.extname(path).delete_prefix(".")
+        end
+
+        def registry
+          Config.configuration.registry
+        end
+      end
+
+      class LoaderNotFoundError < StandardError; end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader/loader_registry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      class LoaderRegistry
+        def initialize
+          @registry = {}
+        end
+
+        def register(loader_class)
+          loader = loader_class.new
+          loader_class.extensions.each do |ext|
+            @registry[ext] = loader
+          end
+        end
+
+        def clear
+          @registry.clear
+        end
+
+        def find_loader(extension)
+          @registry[extension]
+        end
+
+        def registered_extensions
+          @registry.keys
+        end
+
+        def registered_loaders
+          @registry.values.uniq
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/file_loader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module FileLoader
+      require_relative "file_loader/file_loader"
+    end
+  end
+end

data/lib/dev_suite/utils/logger.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    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
+end

data/lib/dev_suite/utils/path_matcher/matcher.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module PathMatcher
+      class Matcher
+        def initialize(includes: [], excludes: [])
+          @include_patterns = includes.map { |pattern| Pattern.new(pattern) }
+          @exclude_patterns = excludes.map { |pattern| Pattern.new(pattern) }
+        end
+
+        def match?(path)
+          return false if excluded?(path)
+          return true if included?(path)
+
+          false
+        end
+
+        private
+
+        def included?(path)
+          @include_patterns.empty? || @include_patterns.any? { |pattern| pattern.match?(path) }
+        end
+
+        def excluded?(path)
+          @exclude_patterns.any? { |pattern| pattern.match?(path) }
+        end
+      end
+    end
+  end
+end

data/lib/dev_suite/utils/path_matcher/path_matcher.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module PathMatcher
+      require_relative "pattern"
+      require_relative "matcher"
+
+      class << self
+        def match?(path, includes: [], excludes: [])
+          matcher = Matcher.new(includes: includes, excludes: excludes)
+          matcher.match?(path)
+        end
+      end
+    end
+  end
+end