sinlog 0.0.5 → 0.0.7

data/lib/sinlog/init.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-require 'singleton'
-require 'logger'
-
-# Logger Singleton Class
-class Sinlog
-  include Singleton
-  attr_reader :logger
-
-  # Define colors for different log levels
-  COLORS = {
-    debug: "\e[34m",   # Blue
-    info: "\e[36m",    # Cyan
-    warn: "\e[33m",    # Yellow
-    error: "\e[31m",   # Red
-    fatal: "\e[35m",   # Magenta
-    unknown: "\e[0m"   # Reset
-  }.freeze
-
-  # log levels
-  LV = {
-    debug: Logger::DEBUG,
-    info: Logger::INFO,
-    warn: Logger::WARN,
-    error: Logger::ERROR,
-    fatal: Logger::FATAL,
-    unknown: Logger::UNKNOWN
-  }.freeze
-
-  # Example:
-  #
-  #     logger = Sinlog.instance.logger
-  #     logger.info "Information"
-  #     logger.debug "This is a debug message"
-  #
-  # The log output format will be similar to:
-  #
-  #   [INFO] 21:29:22.004  Information
-  #   [DEBUG] 21:29:22.005  This is a debug message
-  #
-  # Where "INFO" is highlighted in cyan and "DEBUG" is highlighted in blue.
-  #
-  # The default log level is set based on the RUBY_LOG environment variable.
-  # If this variable is not set, the default level is DEBUG.
-  def initialize
-    @logger = Logger.new($stderr)
-    set_level_from_env!
-    @logger.formatter = proc do |severity, datetime, progname, msg|
-      color = COLORS[severity.downcase.to_sym]
-      reset = COLORS[:unknown]
-      formatted_datetime = datetime.strftime('%H:%M:%S.%L')
-      prog = format_prog_name(progname)
-      "[#{color}#{severity}#{reset}] #{formatted_datetime} #{prog}#{msg}\n"
-    end
-  end
-
-  def self.logger
-    instance.logger
-  end
-
-  # Example:
-  #
-  #     require 'sinlog'
-  #     dbg_logger = Sinlog.with_level(Sinlog::LV[:debug])
-  #     dbg_logger.info "This is an info message"
-  #     dbg_logger.debug "This is a debug message"
-  def self.logger_with_level(level = LV[:warn])
-    instance.logger.tap { _1.level = level }
-  end
-
-  # Set the `@logger.level` (**log level**) based on the value of an environment variable.
-  #
-  # If env_name is not specified, it reads the value of the `RUBY_LOG` environment variable.
-  #
-  # - If the value exists, it is converted to lowercase, then to a symbol, and looked up in the LV hash;
-  # - If it does not exist, the default level is DEBUG;
-  # - If the lookup result is invalid, the level is set to UNKNOWN;
-  # - If the environment variable value is empty, the lookup result will be invalid,
-  #   and the level will be set to UNKNOWN.
-  #
-  # Example:
-  #
-  #     ENV["XX_LOG"] = "info" # or setenv in posix-sh: export XX_LOG=info
-  #     logger = Sinlog.instance.tap { it.set_level_from_env!("XX_LOG") }.logger
-  #
-  #     logger.debug "This message will not be displayed because the current log level is info"
-  #     logger.info "Hello!"
-  def set_level_from_env!(env_name = 'RUBY_LOG')
-    env_lv = ENV[env_name]&.downcase&.to_sym || :debug
-
-    (LV[env_lv] || Logger::UNKNOWN)
-      .then { @logger.level = _1 }
-  end
-
-  private
-
-  def format_prog_name(progname)
-    return '' if progname.to_s.empty?
-
-    green = "\e[32m"
-    reset = "\e[0m"
-    space = ' '
-    "<#{green}#{progname}#{reset}>#{space}"
-  end
-end

data/lib/sinlog/log_ext.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-class Sinlog
-  # LogExt is a Refinement that adds convenient logging methods to all objects.
-  #
-  # When activated with `using Sinlog::LogExt`, any object can call:
-  #
-  # == Overview
-  #
-  # * `log_dbg`   – Logs the object at DEBUG level
-  # * `log_info`  – Logs the object at INFO level
-  # * `log_warn`  – Logs the object at WARN level
-  # * `log_err`   – Logs the object at ERROR level
-  # * `log_fatal` – Logs the object at FATAL level
-  # * `log_unk`   – Logs the object at UNKNOWN level
-  #
-  # == Example
-  #
-  #     require 'sinlog'
-  #
-  #     class A
-  #       using Sinlog::LogExt
-  #       def demo
-  #         "Something happened".log_warn
-  #       end
-  #     end
-  #
-  module LogExt
-    refine Object do
-      # Logs the current object at *debug* level using Sinlog.logger
-      def log_dbg
-        Sinlog.logger.debug(self)
-      end
-
-      # Logs the current object at *information* level using Sinlog.logger
-      def log_info
-        Sinlog.logger.info(self)
-      end
-
-      # Logs the current object at *warning* level using Sinlog.logger
-      def log_warn
-        Sinlog.logger.warn(self)
-      end
-
-      # Logs the current object at *error* level using Sinlog.logger
-      def log_err
-        Sinlog.logger.error(self)
-      end
-
-      # Logs the current object at *fatal* level using Sinlog.logger
-      def log_fatal
-        Sinlog.logger.fatal(self)
-      end
-
-      # Logs the current object at *unknown* level using Sinlog.logger
-      def log_unk
-        Sinlog.logger.unknown(self)
-      end
-      # -----
-    end
-  end
-end

data/lib/sinlog/log_short_ext.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-class Sinlog
-  # LogShortExt is a Refinement that adds convenient logging methods to all objects.
-  #
-  # Similar to LogExt, but methods omit the `log_` prefix.
-  #
-  # For example:
-  #   * `"msg".err` instead of `"msg".log_err`;
-  #   * `"msg".warn` instead of `"msg".log_warn`
-  #
-  # When activated with `using Sinlog::LogShortExt`, any object can call:
-  #
-  # == Overview
-  #
-  # * `dbg`   – Logs the object at DEBUG level
-  # * `info`  – Logs the object at INFO level
-  # * `warn`  – Logs the object at WARN level
-  # * `err`   – Logs the object at ERROR level
-  # * `fatal` – Logs the object at FATAL level
-  # * `unk`   – Logs the object at UNKNOWN level
-  #
-  # == Example
-  #
-  #     require 'sinlog'
-  #
-  #     class A
-  #       using Sinlog::LogShortExt
-  #
-  #       def demo
-  #         "Something happened".warn
-  #       end
-  #     end
-  #
-  module LogShortExt
-    # Logs the current object at *debug* level using Sinlog.logger
-    refine Object do
-      def dbg
-        Sinlog.logger.debug(self)
-      end
-
-      # Logs the current object at *information* level using Sinlog.logger
-      def info
-        Sinlog.logger.info(self)
-      end
-
-      # Logs the current object at *warning* level using Sinlog.logger
-      def warn
-        Sinlog.logger.warn(self)
-      end
-
-      # Logs the current object at *error* level using Sinlog.logger
-      def err
-        Sinlog.logger.error(self)
-      end
-
-      # Logs the current object at *fatal* level using Sinlog.logger
-      def fatal
-        Sinlog.logger.fatal(self)
-      end
-
-      # Logs the current object at *unknown* level using Sinlog.logger
-      def unk
-        Sinlog.logger.unknown(self)
-      end
-      # -----
-    end
-  end
-end

data/lib/sinlog/loggable.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-class Sinlog
-  # Provides logging helpers for any object.
-  #
-  # == Overview
-  #
-  # * `log_dbg`   – Logs the object at DEBUG level
-  # * `log_info`  – Logs the object at INFO level
-  # * `log_warn`  – Logs the object at WARN level
-  # * `log_err`   – Logs the object at ERROR level
-  # * `log_fatal` – Logs the object at FATAL level
-  # * `log_unk`   – Logs the object at UNKNOWN level
-  #
-  # == Example
-  #
-  #     require 'sinlog'
-  #
-  #     include Sinlog::Loggable
-  #
-  #     "A debug message".log_dbg
-  #     "Hello, world".log_info
-  #
-  module Loggable
-    # Logs the current object at *debug* level using Sinlog.logger
-    def log_dbg
-      Sinlog.logger.debug(self)
-    end
-
-    # Logs the current object at *information* level using Sinlog.logger
-    # logger.info
-    def log_info
-      Sinlog.logger.info(self)
-    end
-
-    # Logs the current object at *warning* level using Sinlog.logger
-    def log_warn
-      Sinlog.logger.warn(self)
-    end
-
-    # Logs the current object at *error* level using Sinlog.logger
-    def log_err
-      Sinlog.logger.error(self)
-    end
-
-    # Logs the current object at *fatal* level using Sinlog.logger
-    def log_fatal
-      Sinlog.logger.fatal(self)
-    end
-
-    # Logs the current object at *unknown* level using Sinlog.logger
-    def log_unk
-      Sinlog.logger.unknown(self)
-    end
-    # -----
-  end
-end

data/rbi/sinlog/init.rbi

@@ -1,34 +0,0 @@
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-class Sinlog
-  include ::Singleton::SingletonInstanceMethods
-  include ::Singleton
-  extend ::Singleton::SingletonClassMethods
-
-  sig { params(level: Integer).returns(Logger) }
-  def self.logger_with_level(level = LV[:warn]); end
-
-  sig { returns(Logger) }
-  def self.logger; end
-
-  sig { returns(Logger) }
-  def logger; end
-
-  sig { params(env_name: String).returns(NilClass) }
-  def set_level_from_env!(env_name = ''); end
-
-  private
-
-  sig { params(progname: T.any(String, Symbol)).returns(String) }
-  def format_prog_name(progname); end
-end
-
-Sinlog::COLORS = T.let(T.unsafe(nil), T::Hash[Symbol, String])
-
-Sinlog::LV = T.let(T.unsafe(nil), T::Hash[Symbol, Integer])
-
-# ---------
-# LambdaExt
-# LoggerFn = T.type_alias { T.proc.params(msg: T.untyped).void }

data/rbi/sinlog/log_ext.rbi

@@ -1,27 +0,0 @@
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-class Sinlog
-  module LogExt
-    refine Object do
-      sig { void }
-      def log_dbg; end
-
-      sig { void }
-      def log_info; end
-
-      sig { void }
-      def log_warn; end
-
-      sig { void }
-      def log_err; end
-
-      sig { void }
-      def log_fatal; end
-
-      sig { void }
-      def log_unk; end
-    end
-  end
-end

data/rbi/sinlog/log_short_ext.rbi

@@ -1,27 +0,0 @@
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-class Sinlog
-  module LogShortExt
-    refine Object do
-      sig { void }
-      def dbg; end
-
-      sig { void }
-      def info; end
-
-      sig { void }
-      def warn; end
-
-      sig { void }
-      def err; end
-
-      sig { void }
-      def fatal; end
-
-      sig { void }
-      def unk; end
-    end
-  end
-end

data/rbi/sinlog/loggable.rbi

@@ -1,25 +0,0 @@
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-class Sinlog
-  module Loggable
-    sig { void }
-    def log_dbg; end
-
-    sig { void }
-    def log_info; end
-
-    sig { void }
-    def log_warn; end
-
-    sig { void }
-    def log_err; end
-
-    sig { void }
-    def log_fatal; end
-
-    sig { void }
-    def log_unk; end
-  end
-end

data/rbi/sinlog/version.rbi

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-Sinlog::VERSION = T.let(T.unsafe(nil), String)