sinlog 0.0.6 → 0.0.7

data/.rubocop.yml

@@ -1,33 +0,0 @@
-# ln ~/.config/rubocop/config.yml .rubocop.yml
-AllCops:
-  TargetRubyVersion: 3.1
-
-Lint/MissingCopEnableDirective:
-  Enabled: false
-Lint/RedundantCopDisableDirective:
-  Enabled: false
-Lint/EmptyExpression:
-  # disabled => allow ()
-  Enabled: false
-
-# https://docs.rubocop.org/rubocop/cops_style.html
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyle: diff_comma
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyle: diff_comma
-Style/Lambda:
-  EnforcedStyle: literal
-Style/ModuleFunction:
-  # EnforcedStyle: extend_self
-  EnforcedStyle: module_function
-Style/BlockDelimiters:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-
-# https://docs.rubocop.org/rubocop/cops_layout.html
-Layout/CaseIndentation:
-  EnforcedStyle: end
-  IndentOneStep: true
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver

data/lib/sinlog/log_ext.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Sinlog
-  # == Overview
-  #
-  # * `log_dbg`   – DEBUG
-  # * `log_info`  – INFO
-  # * `log_warn`  – WARN
-  # * `log_err`   – ERROR
-  # * `log_fatal` – FATAL
-  # * `log_unk`   – UNKNOWN
-  #
-  module LogExt
-    # 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
-  # -----
-  private_constant :LogExt
-end

data/lib/sinlog/logger.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-# Logger Singleton Class
-module Sinlog
-  class Logger
-    require 'singleton'
-
-    include Singleton
-    attr_reader :logger
-
-    # Example:
-    #
-    #     logger = Sinlog::Logger.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 = StdLogger.new($stderr)
-      set_level_from_env!
-      @logger.formatter = Kernel.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
-
-    # 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(0);
-    # - If the lookup result is invalid, the level is set to ERROR(3);
-    # - If the environment variable value is empty, the lookup result will be invalid,
-    #   and the level will be set to ERROR(3).
-    #
-    # Example:
-    #
-    #     ENV["XX_LOG"] = "info" # or setenv in posix-sh: export XX_LOG=info
-    #     logger = Sinlog::Logger.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_str = ENV[env_name]&.downcase || 'debug'
-
-      Sinlog
-        .to_log_level(env_str)
-        .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
-end

data/lib/sinlog/short_ext.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Sinlog
-  # LogShortExt is a module that adds convenient logging methods.
-  #
-  # 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`
-  #
-  # We can activate it with `using Sinlog::ShortRefin`
-  #
-  # == Overview
-  #
-  # * `dbg`   – DEBUG
-  # * `info`  – INFO
-  # * `warn`  – WARN
-  # * `err`   – ERROR
-  # * `fatal` – FATAL
-  # * `unk`   – UNKNOWN
-  module LogShortExt
-    # Logs the current object at *debug* level using Sinlog.logger
-    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
-  private_constant :LogShortExt
-end

data/rbi/sinlog.rbi

@@ -1,95 +0,0 @@
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-module Sinlog
-  class Logger
-    include ::Singleton::SingletonInstanceMethods
-    include ::Singleton
-    extend ::Singleton::SingletonClassMethods
-
-    sig { params(level: T.nilable(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
-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 }
-
-# rubocop:disable Style/FrozenStringLiteralComment
-# rubocop:disable Style/Documentation
-# typed: true
-
-class Object
-  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
-
-class Object
-  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
-
-# -----
-LevelType = T.type_alias { T.nilable(T.any(String, Integer, Symbol)) }
-
-module Sinlog
-  module_function # rubocop:disable Lint/UselessAccessModifier,Style/ModuleFunction
-
-  sig { params(level: LevelType).returns(T.untyped) }
-  def to_log_level(level); end
-
-  sig { returns(Sinlog::Logger) }
-  def instance; end
-
-  sig { params(env_name: T.nilable(String), level: LevelType).returns(::Logger) }
-  def logger(env_name: nil, level: nil); end
-end