makit 0.0.164 → 0.0.166

data/lib/makit/logging/configuration.rb

@@ -1,309 +1,309 @@
-# frozen_string_literal: true
-
-module Makit
-  module Logging
-    # Configuration management for unified logging
-    #
-    # Provides schema validation, default configurations, and helper methods
-    # for setting up the unified file sink with various output configurations.
-    #
-    # @example Basic configuration
-    #   config = Configuration.new(
-    #     configurations: [
-    #       { file: $stdout, format: :console },
-    #       { file: "logs/app.log", format: :json }
-    #     ]
-    #   )
-    #
-    # @example YAML configuration
-    #   config = Configuration.from_yaml("config/logging.yml")
-    #
-    # @example Environment-based configuration
-    #   config = Configuration.for_environment(:production)
-    class Configuration
-      # @return [Array<Hash>] list of output configurations
-      attr_reader :configurations
-
-      # Initialize configuration
-      #
-      # @param configurations [Array<Hash>] list of output configurations
-      def initialize(configurations: [])
-        @configurations = configurations
-      end
-
-      # Create configuration from YAML file
-      #
-      # @param yaml_file [String] path to YAML configuration file
-      # @return [Configuration] new configuration instance
-      def self.from_yaml(yaml_file)
-        require "yaml"
-        data = YAML.load_file(yaml_file)
-        configurations = data["logging"]["sinks"] || []
-
-        # Convert string keys to symbols
-        configurations = configurations.map do |config|
-          config.transform_keys(&:to_sym)
-        end
-
-        new(configurations: configurations)
-      end
-
-      # Create configuration from JSON file
-      #
-      # @param json_file [String] path to JSON configuration file
-      # @return [Configuration] new configuration instance
-      def self.from_json(json_file)
-        require "json"
-        data = JSON.parse(File.read(json_file))
-        configurations = data["logging"]["sinks"] || []
-
-        # Convert string keys to symbols
-        configurations = configurations.map do |config|
-          config.transform_keys(&:to_sym)
-        end
-
-        new(configurations: configurations)
-      end
-
-      # Create environment-specific configuration
-      #
-      # @param environment [Symbol] environment name (:development, :production, :test)
-      # @return [Configuration] new configuration instance
-      def self.for_environment(environment)
-        case environment
-        when :development
-          development_config
-        when :production
-          production_config
-        when :test
-          test_config
-        when :ci
-          ci_config
-        else
-          default_config
-        end
-      end
-
-      # Get default configuration
-      #
-      # @return [Configuration] default configuration
-      def self.default_config
-        require_relative "../logging" unless defined?(Makit::Logging)
-        new(
-          configurations: [
-            { file: $stdout, format: :console },
-            { file: Makit::Logging.log_file_path("makit.log"), format: :json, append: true },
-          ],
-        )
-      end
-
-      # Get development configuration
-      #
-      # @return [Configuration] development configuration
-      def self.development_config
-        new(
-          configurations: [
-            {
-              file: $stdout,
-              format: :console,
-              show_timestamp: true,
-              show_level: true,
-            },
-            {
-              file: "logs/development.log",
-              format: :text,
-              append: true,
-              include_context: true,
-            },
-            {
-              file: "logs/debug.log",
-              format: :json,
-              append: true,
-              min_level: :debug,
-            },
-          ],
-        )
-      end
-
-      # Get production configuration
-      #
-      # @return [Configuration] production configuration
-      def self.production_config
-        new(
-          configurations: [
-            {
-              file: "logs/application.log",
-              format: :json,
-              append: true,
-              include_metadata: true,
-              rotation: { max_size: "100MB", max_files: 10 },
-            },
-            {
-              file: "logs/errors.log",
-              format: :json,
-              append: true,
-              min_level: :error,
-              include_metadata: true,
-            },
-          ],
-        )
-      end
-
-      # Get test configuration
-      #
-      # @return [Configuration] test configuration
-      def self.test_config
-        new(
-          configurations: [
-            {
-              file: "logs/test.log",
-              format: :text,
-              append: false,
-              include_context: true,
-            },
-          ],
-        )
-      end
-
-      # Get CI/CD configuration
-      #
-      # @return [Configuration] CI configuration
-      def self.ci_config
-        new(
-          configurations: [
-            {
-              file: $stdout,
-              format: :console,
-              show_level: true,
-            },
-            {
-              file: "artifacts/build.log",
-              format: :json,
-              append: true,
-              include_metadata: true,
-            },
-          ],
-        )
-      end
-
-      # Validate configuration
-      #
-      # @return [Boolean] true if valid
-      # @raise [ArgumentError] if configuration is invalid
-      def validate!
-        raise ArgumentError, "configurations must be an array" unless @configurations.is_a?(Array)
-        raise ArgumentError, "at least one configuration is required" if @configurations.empty?
-
-        @configurations.each_with_index do |config, index|
-          validate_single_configuration(config, index)
-        end
-
-        true
-      end
-
-      # Check if configuration is valid
-      #
-      # @return [Boolean] true if valid
-      def valid?
-        validate!
-        true
-      rescue ArgumentError
-        false
-      end
-
-      # Get configuration as hash
-      #
-      # @return [Hash] configuration as hash
-      def to_hash
-        {
-          logging: {
-            sinks: @configurations,
-          },
-        }
-      end
-
-      # Save configuration to YAML file
-      #
-      # @param yaml_file [String] path to YAML file
-      # @return [void]
-      def save_yaml(yaml_file)
-        require "yaml"
-        FileUtils.mkdir_p(File.dirname(yaml_file))
-        File.write(yaml_file, to_hash.to_yaml)
-      end
-
-      # Save configuration to JSON file
-      #
-      # @param json_file [String] path to JSON file
-      # @return [void]
-      def save_json(json_file)
-        require "json"
-        FileUtils.mkdir_p(File.dirname(json_file))
-        File.write(json_file, JSON.pretty_generate(to_hash))
-      end
-
-      private
-
-      # Validate a single configuration
-      #
-      # @param config [Hash] configuration to validate
-      # @param index [Integer] configuration index for error messages
-      # @raise [ArgumentError] if configuration is invalid
-      def validate_single_configuration(config, index)
-        raise ArgumentError, "configuration #{index} must be a hash" unless config.is_a?(Hash)
-
-        required_keys = %i[file format]
-        missing_keys = required_keys - config.keys
-        unless missing_keys.empty?
-          raise ArgumentError,
-                "configuration #{index} missing required keys: #{missing_keys.join(", ")}"
-        end
-
-        # Validate file
-        file = config[:file]
-        unless file.is_a?(String) || file.is_a?(IO) || file.respond_to?(:write)
-          raise ArgumentError, "configuration #{index} file must be a String path, IO object, or writable object"
-        end
-
-        # Validate format
-        format = config[:format]
-        unless format.is_a?(Symbol) || format.is_a?(String)
-          raise ArgumentError, "configuration #{index} format must be a Symbol or String"
-        end
-
-        # Validate log levels if specified
-        if config[:min_level] && !valid_log_level?(config[:min_level])
-          raise ArgumentError, "configuration #{index} min_level must be a valid log level"
-        end
-
-        if config[:max_level] && !valid_log_level?(config[:max_level])
-          raise ArgumentError, "configuration #{index} max_level must be a valid log level"
-        end
-
-        # Validate rotation if specified
-        return unless config[:rotation] && !valid_rotation_config?(config[:rotation])
-
-        raise ArgumentError, "configuration #{index} rotation must be a valid rotation configuration"
-      end
-
-      # Check if log level is valid
-      #
-      # @param level [Symbol] log level to check
-      # @return [Boolean] true if valid
-      def valid_log_level?(level)
-        %i[debug info warn error fatal success].include?(level)
-      end
-
-      # Check if rotation configuration is valid
-      #
-      # @param rotation [Hash] rotation configuration
-      # @return [Boolean] true if valid
-      def valid_rotation_config?(rotation)
-        return false unless rotation.is_a?(Hash)
-
-        valid_keys = %i[max_size max_files compress pattern]
-        rotation.keys.all? { |key| valid_keys.include?(key) }
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Makit
+  module Logging
+    # Configuration management for unified logging
+    #
+    # Provides schema validation, default configurations, and helper methods
+    # for setting up the unified file sink with various output configurations.
+    #
+    # @example Basic configuration
+    #   config = Configuration.new(
+    #     configurations: [
+    #       { file: $stdout, format: :console },
+    #       { file: "logs/app.log", format: :json }
+    #     ]
+    #   )
+    #
+    # @example YAML configuration
+    #   config = Configuration.from_yaml("config/logging.yml")
+    #
+    # @example Environment-based configuration
+    #   config = Configuration.for_environment(:production)
+    class Configuration
+      # @return [Array<Hash>] list of output configurations
+      attr_reader :configurations
+
+      # Initialize configuration
+      #
+      # @param configurations [Array<Hash>] list of output configurations
+      def initialize(configurations: [])
+        @configurations = configurations
+      end
+
+      # Create configuration from YAML file
+      #
+      # @param yaml_file [String] path to YAML configuration file
+      # @return [Configuration] new configuration instance
+      def self.from_yaml(yaml_file)
+        require "yaml"
+        data = YAML.load_file(yaml_file)
+        configurations = data["logging"]["sinks"] || []
+
+        # Convert string keys to symbols
+        configurations = configurations.map do |config|
+          config.transform_keys(&:to_sym)
+        end
+
+        new(configurations: configurations)
+      end
+
+      # Create configuration from JSON file
+      #
+      # @param json_file [String] path to JSON configuration file
+      # @return [Configuration] new configuration instance
+      def self.from_json(json_file)
+        require "json"
+        data = JSON.parse(File.read(json_file))
+        configurations = data["logging"]["sinks"] || []
+
+        # Convert string keys to symbols
+        configurations = configurations.map do |config|
+          config.transform_keys(&:to_sym)
+        end
+
+        new(configurations: configurations)
+      end
+
+      # Create environment-specific configuration
+      #
+      # @param environment [Symbol] environment name (:development, :production, :test)
+      # @return [Configuration] new configuration instance
+      def self.for_environment(environment)
+        case environment
+        when :development
+          development_config
+        when :production
+          production_config
+        when :test
+          test_config
+        when :ci
+          ci_config
+        else
+          default_config
+        end
+      end
+
+      # Get default configuration
+      #
+      # @return [Configuration] default configuration
+      def self.default_config
+        require_relative "../logging" unless defined?(Makit::Logging)
+        new(
+          configurations: [
+            { file: $stdout, format: :console },
+            { file: Makit::Logging.log_file_path("makit.log"), format: :json, append: true },
+          ],
+        )
+      end
+
+      # Get development configuration
+      #
+      # @return [Configuration] development configuration
+      def self.development_config
+        new(
+          configurations: [
+            {
+              file: $stdout,
+              format: :console,
+              show_timestamp: true,
+              show_level: true,
+            },
+            {
+              file: "logs/development.log",
+              format: :text,
+              append: true,
+              include_context: true,
+            },
+            {
+              file: "logs/debug.log",
+              format: :json,
+              append: true,
+              min_level: :debug,
+            },
+          ],
+        )
+      end
+
+      # Get production configuration
+      #
+      # @return [Configuration] production configuration
+      def self.production_config
+        new(
+          configurations: [
+            {
+              file: "logs/application.log",
+              format: :json,
+              append: true,
+              include_metadata: true,
+              rotation: { max_size: "100MB", max_files: 10 },
+            },
+            {
+              file: "logs/errors.log",
+              format: :json,
+              append: true,
+              min_level: :error,
+              include_metadata: true,
+            },
+          ],
+        )
+      end
+
+      # Get test configuration
+      #
+      # @return [Configuration] test configuration
+      def self.test_config
+        new(
+          configurations: [
+            {
+              file: "logs/test.log",
+              format: :text,
+              append: false,
+              include_context: true,
+            },
+          ],
+        )
+      end
+
+      # Get CI/CD configuration
+      #
+      # @return [Configuration] CI configuration
+      def self.ci_config
+        new(
+          configurations: [
+            {
+              file: $stdout,
+              format: :console,
+              show_level: true,
+            },
+            {
+              file: "artifacts/build.log",
+              format: :json,
+              append: true,
+              include_metadata: true,
+            },
+          ],
+        )
+      end
+
+      # Validate configuration
+      #
+      # @return [Boolean] true if valid
+      # @raise [ArgumentError] if configuration is invalid
+      def validate!
+        raise ArgumentError, "configurations must be an array" unless @configurations.is_a?(Array)
+        raise ArgumentError, "at least one configuration is required" if @configurations.empty?
+
+        @configurations.each_with_index do |config, index|
+          validate_single_configuration(config, index)
+        end
+
+        true
+      end
+
+      # Check if configuration is valid
+      #
+      # @return [Boolean] true if valid
+      def valid?
+        validate!
+        true
+      rescue ArgumentError
+        false
+      end
+
+      # Get configuration as hash
+      #
+      # @return [Hash] configuration as hash
+      def to_hash
+        {
+          logging: {
+            sinks: @configurations,
+          },
+        }
+      end
+
+      # Save configuration to YAML file
+      #
+      # @param yaml_file [String] path to YAML file
+      # @return [void]
+      def save_yaml(yaml_file)
+        require "yaml"
+        FileUtils.mkdir_p(File.dirname(yaml_file))
+        File.write(yaml_file, to_hash.to_yaml)
+      end
+
+      # Save configuration to JSON file
+      #
+      # @param json_file [String] path to JSON file
+      # @return [void]
+      def save_json(json_file)
+        require "json"
+        FileUtils.mkdir_p(File.dirname(json_file))
+        File.write(json_file, JSON.pretty_generate(to_hash))
+      end
+
+      private
+
+      # Validate a single configuration
+      #
+      # @param config [Hash] configuration to validate
+      # @param index [Integer] configuration index for error messages
+      # @raise [ArgumentError] if configuration is invalid
+      def validate_single_configuration(config, index)
+        raise ArgumentError, "configuration #{index} must be a hash" unless config.is_a?(Hash)
+
+        required_keys = %i[file format]
+        missing_keys = required_keys - config.keys
+        unless missing_keys.empty?
+          raise ArgumentError,
+                "configuration #{index} missing required keys: #{missing_keys.join(", ")}"
+        end
+
+        # Validate file
+        file = config[:file]
+        unless file.is_a?(String) || file.is_a?(IO) || file.respond_to?(:write)
+          raise ArgumentError, "configuration #{index} file must be a String path, IO object, or writable object"
+        end
+
+        # Validate format
+        format = config[:format]
+        unless format.is_a?(Symbol) || format.is_a?(String)
+          raise ArgumentError, "configuration #{index} format must be a Symbol or String"
+        end
+
+        # Validate log levels if specified
+        if config[:min_level] && !valid_log_level?(config[:min_level])
+          raise ArgumentError, "configuration #{index} min_level must be a valid log level"
+        end
+
+        if config[:max_level] && !valid_log_level?(config[:max_level])
+          raise ArgumentError, "configuration #{index} max_level must be a valid log level"
+        end
+
+        # Validate rotation if specified
+        return unless config[:rotation] && !valid_rotation_config?(config[:rotation])
+
+        raise ArgumentError, "configuration #{index} rotation must be a valid rotation configuration"
+      end
+
+      # Check if log level is valid
+      #
+      # @param level [Symbol] log level to check
+      # @return [Boolean] true if valid
+      def valid_log_level?(level)
+        %i[debug info warn error fatal success].include?(level)
+      end
+
+      # Check if rotation configuration is valid
+      #
+      # @param rotation [Hash] rotation configuration
+      # @return [Boolean] true if valid
+      def valid_rotation_config?(rotation)
+        return false unless rotation.is_a?(Hash)
+
+        valid_keys = %i[max_size max_files compress pattern]
+        rotation.keys.all? { |key| valid_keys.include?(key) }
+      end
+    end
+  end
+end