dev_suite 0.2.3 → 0.2.5

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

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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        class Base
+          include Attribute::Manager
+          include Hook::Manager
+
+          def initialize
+            run_hooks(:before_initialize)
+            initialize_config_attrs
+            run_hooks(:after_initialize)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        require_relative "attribute"
+        require_relative "hook"
+        require_relative "base"
+        require_relative "settings"
+        require_relative "configuration"
+        require_relative "manager"
+        require_relative "initializer"
+
+        class << self
+          def included(base)
+            base.extend(Manager)
+            Initializer.define_config_constants(base)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        class Configuration < Base
+          include Settings::Manager
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Hook
+          require_relative "manager"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Hook
+          module Manager
+            class << self
+              def included(base)
+                base.extend(ClassMethods)
+              end
+            end
+
+            module ClassMethods
+              def register_hook(stage, &block)
+                hooks[stage] ||= []
+                hooks[stage] << block
+              end
+
+              def hooks
+                @hooks ||= {}
+              end
+            end
+
+            private
+
+            def run_hooks(stage)
+              self.class.hooks[stage]&.each { |hook| instance_eval(&hook) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Initializer
+          class << self
+            def define_config_constants(base)
+              base.const_set(:BaseConfiguration, Configuration)
+
+              unless base.const_defined?(:Configuration)
+                base.const_set(:Configuration, Class.new(base::BaseConfiguration))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DevSuite
+  module Utils
+    module Construct
+      module Config
+        module Manager
+          # Provides access to a single instance of the configuration class
+          # It dynamically uses the Configuration class in the including module's namespace
+          def configuration
+            @configuration ||= self::Configuration.new
+          end
+
+          # Allows block-based configuration
+          # Example usage:
+          #   ConfigClass.configure do |config|
+          #     config.attr_name = value
+          #   end
+          def configure
+            yield(configuration)
+          rescue StandardError => e
+            ErrorHandler.handle_error(e)
+          end
+
+          # Resets the configuration by reinitializing it with default values
+          def reset!
+            @configuration = self::Configuration.new # Reinitialize the configuration instance
+          end
+        end
+      end
+    end
+  end
+end

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