sinlog 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3fe4df43741e8ad7d0401e9a0c60ec0d7c429f4712ad67b2a930b2f3c40c270
+  data.tar.gz: 4a79394fb547e8dc2e16f5418e80ebd170b93930fcd63c4490241e844a9cdc40
+SHA512:
+  metadata.gz: bb676571612ede8908f76b040756ee8b4de13be37abe2651f7a12e4e7a1b357bc5b3020be2f0631a4e91ddaf1c5b055ff35f6b3f48fcc3ebd4ae4e317cda92a2
+  data.tar.gz: e08d902583da75273357bed1c1615cafd80d128fa9cb5db6c094129ec8a40cff4ea11c2981df403e6b2cf18b260eaf520245fb7e9680874ed71f2356b613008c

data/License

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 2moe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/docs/Readme-zh.md

@@ -0,0 +1,310 @@
+# Sinlog
+
+一个非常非常简单的 ruby 单例日志记录器，其中日志级别带有彩色高亮。
+
+> 单例（Singleton）意味着整个程序会共享同一个实例（日志记录器）。
+
+---
+
+| Language/語言                   | ID         |
+| ------------------------------- | ---------- |
+| 简体中文                        | zh-Hans-CN |
+| [English](./Readme.md)          | en-Latn-US |
+| [繁體中文](./Readme-zh-Hant.md) | zh-Hant-TW |
+
+---
+
+<details>
+<summary>
+目录（点击展开）
+</summary>
+
+- [Learn Sinlog API By Example](#learn-sinlog-api-by-example)
+  - [include module](#include-module)
+    - [LambdaExt](#lambdaext)
+    - [LogLambdaExt](#loglambdaext)
+  - [Classic Method Call](#classic-method-call)
+- [进阶](#进阶)
+  - [Real World Example](#real-world-example)
+  - [日志级别](#日志级别)
+  - [环境变量](#环境变量)
+  - [日志输出设备/路径](#日志输出设备路径)
+  - [其他 logger 方法](#其他-logger-方法)
+  - [注意事项](#注意事项)
+- [题外话](#题外话)
+- [License](#license)
+
+</details>
+
+## Learn Sinlog API By Example
+
+首先，安装 sinlog。
+
+```sh
+gem install sinlog
+```
+
+然后，我们可以运行 `irb` 来快速体验一番。
+
+### include module
+
+#### LambdaExt
+
+当出现： `irb(main):001>` 后，我们就能开始操作了。
+
+```ruby
+irb(main):001> require 'sinlog'
+
+irb(main):002> include Sinlog::LambdaExt
+# 它提供了: dbg, info, warning, err, fatal, unk
+# 我们可以用 .tap(&dbg) 或 .then(&dbg) 来调用。
+
+irb(main):003> 'debug'.tap(&dbg)
+irb(main):004> 'information'.tap(&info)
+
+# 注：创建 warn 方法，会导致 irb 的补全功能出问题。
+#   因此 LambdaExt 用的是 warning, 而不是 warn。
+#   您如果确实需要 warn，那就调用 include Sinlog::LambdaWarnExt
+irb(main):005> 'warning'.tap(&warning)
+
+irb(main):006> 'error'.tap(&err)
+irb(main):007> 'fatal'.tap(&fatal)
+irb(main):008> 'unknown'.tap(&unk)
+```
+
+<img src="../assets/img/LambdaExt.jpg" alt="LambdaExt" style="width: 50%; height: 50%">
+
+LambdaExt 提供了:
+
+- dbg
+- info
+- warning
+- wng (与 warning 相同，只是名称不同)
+- err
+- fatal
+- unk
+
+#### LogLambdaExt
+
+有一个与 LambdaExt 特别相似的模块，名为 LogLambdaExt。  
+它们之间最主要的区别在于 lambda 函数的名称。
+
+- LogLambdaExt 带有 `log_` 前缀
+- LambdaExt 没有
+
+LambdaExt 与 LogLambdaExt 可以同时 include, 不过在一般情况下，我们引入其中一个就够用了。
+
+至于哪一个更好呢？
+
+我们不妨亲自上手试试，了解其中的区别，最后挑一个自己喜欢的。
+
+```ruby
+irb(main):009> include Sinlog::LogLambdaExt
+# 它提供了 log_dbg, log_info, log_warn, log_err, log_fatal, log_unk
+# 我们可以用 .tap(&log_dbg) 或 .then(&log_dbg) 来调用。
+
+irb(main):010> "debug".tap(&log_dbg)
+irb(main):011> "information".tap(&log_info)
+
+# 注：这里用的是 log_warn，而不是 log_warning
+irb(main):012> "warning".tap(&log_warn)
+
+irb(main):013> "error".tap(&log_err)
+irb(main):014> "fatal".tap(&log_fatal)
+irb(main):015> "unknown".tap(&log_unk)
+```
+
+```ruby
+# 这是一个更复杂的例子
+irb(main):016> require 'pathname'
+
+irb(main):017> Pathname('lib/lambda.rb').tap do
+    "Filename: #{it}".then(&log_info)
+    "size: #{
+      it
+        .tap{ '⚠️ 获取文件大小可能会失败'.then(&log_warn) }
+        .size
+    }".then(&log_info)
+end
+```
+
+<img src="../assets/img/LogLambdaExt.jpg" alt="LogLambdaExt" style="width: 90%; height: 90%">
+
+LogLambdaExt 提供了:
+
+- log_dbg
+- log_info
+- log_warn
+- log_warning (与 log_warn 相同，只是名称不同)
+- log_wng (与 log_warn 相同，只是名称不同)
+- log_err
+- log_fatal
+- log_unk
+
+### Classic Method Call
+
+您如果不喜欢 lambda，那就试试经典的方法调用吧！
+
+先运行 irb 进入 ruby repl，接着一步一步运行。
+
+```ruby
+irb(main):001> require 'sinlog'
+
+irb(main):002> log = Sinlog.instance.logger
+
+irb(main):003> log.debug 'debug'
+irb(main):004> log.info 'information'
+irb(main):005> log.warn 'warning'
+irb(main):006> log.error 'error'
+irb(main):007> log.fatal 'fatal'
+irb(main):008> log.unknown 'unknown'
+```
+
+Sinlog.instance.logger 提供了 ruby 标准库的 logger 的方法。
+
+最常见的有：
+
+- debug
+- info
+- warn
+- error
+- fatal
+- unknown
+
+## 进阶
+
+在亲自上手尝试之后，我们已经对 sinlog 有了初步的了解。  
+在一般情况下，了解其基本用法就已经足够了。
+
+您如果对此感兴趣的话，不妨与我一同继续探索。
+
+### Real World Example
+
+在现实世界中，我们的程序可能会是这样子的：
+
+```ruby
+require 'sinlog'
+
+class EpubProcessor
+  def initialize(epub_file, logger = nil)
+    @epub = epub_file
+    @logger = logger || Sinlog.instance.tap { it.fetch_env_and_update_log_level("XX_LOG") }.logger
+    @logger.debug "EpubProcessor class 初始化完成。"
+
+  end
+end
+```
+
+我们可能会定义类的 @logger 实例变量，并允许自定义 logger。
+
+简单来说，我们可能会对 logger 进行更精细化的配置。
+
+在接下来的内容中，我们将探讨如何进行“更精细化的配置”。
+
+### 日志级别
+
+日志级别从低到高，依次是：
+
+- debug = 0
+- info = 1
+- warn = 2
+- error = 3
+- fatal = 4
+- unknown = 5
+
+```ruby
+p Sinlog::LV
+# => {debug: 0, info: 1, warn: 2, error: 3, fatal: 4, unknown: 5}
+
+# 将日志级别修改为 warn
+log = Sinlog.instance.logger.tap {it.level = Sinlog::LV[:warn]}
+# 或者是：
+# log = Sinlog.instance.logger.tap {it.level = 2}
+
+log.error "这条消息会显示出来！低级别 WARN（2）会显示高级别 ERROR(3) 的日志。"
+log.info "这条消息不会显示出来！高级别 WARN(2) 不会显示低级别 INFO(1) 的日志。"
+```
+
+- 日志级别越低，显示的内容越详细。
+- 低级别 **会** 显示高级别的日志。
+- 高级别 **不会** 显示低级别的日志。
+
+### 环境变量
+
+在现实世界中，对于客户端应用，最后运行程序的是普通用户。  
+为了能让普通用户直接配置 log.level，我们可以通过环境变量来配置。
+
+> 使用环境变量足够简单也足够高效。
+
+Sinlog 在默认情况下，会尝试读取环境变量 RUBY_LOG 的值。
+
+本质上调用了 `fetch_env_and_update_log_level(env_name = 'RUBY_LOG')` 函数。
+
+- 若该环境变量不存在，则使用 debug(0)。
+- 若该环境变量存在，且其值为空，则使用 unknown(5)。
+- 若该环境变量的值无效，则使用 unknown(5)。
+
+我们可以用 POSIX-sh 设置环境变量，然后 logger 在初始化的时候，就会自动将日志级别设置为（RUBY_LOG的值）warn。
+
+```sh
+# 可选值：debug, info, warn, error, fatal
+export RUBY_LOG=warn
+```
+
+您如果不想要默认的 RUBY_LOG 环境变量，而是想要 XX_CLI_LOG 的值，那可以这样子做：
+
+POSIX-sh:
+
+```sh
+export XX_CLI_LOG=info
+```
+
+ruby:
+
+```ruby
+logger = Sinlog.instance.tap { it.fetch_env_and_update_log_level("XX_CLI_LOG") }.logger
+
+logger.debug "由于当前日志级别为 INFO(1)，因此不会显示此消息 DEBUG(0)。"
+logger.info "Hello!"
+```
+
+### 日志输出设备/路径
+
+默认情况下，Sinlog 会输出到 STDERR。
+
+您如果需要自定义日志输出路径的话，那可以调用 logger 的 reopen 方法。
+
+```ruby
+# 日志会输出到 a.log 文件
+log = Sinlog.instance.logger.tap {it.reopen("a.log")}
+
+log.error "发生甚么事了！QuQ"
+```
+
+OR:
+
+```ruby
+log = Sinlog.instance.logger
+log.reopen("a.log")
+
+log.error "发生甚么事了！QuQ"
+```
+
+### 其他 logger 方法
+
+除了 `.reopen`, `.level` 外，我们还可以在 `Sinlog.instance.logger` 上调用 ruby 标准库的 logger 的其他方法。
+
+### 注意事项
+
+Sinlog 用的是 Singleton 单例模式，整个程序会共享同一个实例（日志记录器）。
+
+在同一个程序的 class A 中修改 Sinlog 后，会影响到 class B 的 Sinlog。
+
+## 题外话
+
+这是我发布的第一个 ruby gem。  
+其中的 api 不一定符合地道的 ruby 用法，还请大家多多谅解。
+
+## License
+
+[MIT License](../License)

data/docs/Readme.md

@@ -0,0 +1,313 @@
+# Sinlog
+
+A very, very simple Ruby singleton logger with colored log levels.
+
+> Singleton means that the entire program will share the same instance (logger).
+
+---
+
+| Language/語言                   | ID         |
+| ------------------------------- | ---------- |
+| English                         | en-Latn-US |
+| [简体中文](./Readme-zh.md)      | zh-Hans-CN |
+| [繁體中文](./Readme-zh-Hant.md) | zh-Hant-TW |
+
+> Want to support Mehr Sprachen/Más idiomas/Autres langues/Другие языки/...?
+>
+> Please feel free to send me an issue!
+
+---
+
+<details>
+<summary>
+Table of Contents (click to expand)
+</summary>
+
+- [Learn Sinlog API By Example](#learn-sinlog-api-by-example)
+  - [include module](#include-module)
+    - [LambdaExt](#lambdaext)
+    - [LogLambdaExt](#loglambdaext)
+  - [Classic Method Call](#classic-method-call)
+- [Advanced](#advanced)
+  - [Real World Example](#real-world-example)
+  - [Log Levels](#log-levels)
+  - [Environment Variables](#environment-variables)
+  - [Log Output Device/Path](#log-output-devicepath)
+  - [Other Logger Methods](#other-logger-methods)
+  - [Notes](#notes)
+- [Side Note](#side-note)
+- [License](#license)
+
+</details>
+
+## Learn Sinlog API By Example
+
+First, install `sinlog`.
+
+```sh
+gem install sinlog
+```
+
+Then, we can run `irb` to quickly try it out.
+
+### include module
+
+#### LambdaExt
+
+When you see: `irb(main):001>`, we can start operating.
+
+```ruby
+irb(main):001> require 'sinlog'
+
+irb(main):002> include Sinlog::LambdaExt
+# It provides: dbg, info, warning, err, fatal, unk
+# We can call them using .tap(&dbg) or .then(&dbg).
+
+irb(main):003> 'debug'.tap(&dbg)
+irb(main):004> 'information'.tap(&info)
+
+# Note: Creating a warn method will cause issues with irb's auto-completion.
+# Therefore, LambdaExt uses warning instead of warn.
+# If you really need warn, then call include Sinlog::LambdaWarnExt
+irb(main):005> 'warning'.tap(&warning)
+
+irb(main):006> 'error'.tap(&err)
+irb(main):007> 'fatal'.tap(&fatal)
+irb(main):008> 'unknown'.tap(&unk)
+```
+
+<img src="../assets/img/LambdaExt.jpg" alt="LambdaExt" style="width: 50%; height: 50%">
+
+LambdaExt provides:
+
+- dbg
+- info
+- warning
+- wng (same as warning, just a different name)
+- err
+- fatal
+- unk
+
+#### LogLambdaExt
+
+There is a module very similar to LambdaExt called LogLambdaExt.  
+The main difference between them is the naming of the lambda functions.
+
+- LogLambdaExt has a `log_` prefix
+- LambdaExt does not
+
+LambdaExt and LogLambdaExt can be included simultaneously, but in general, including one of them is sufficient.
+
+Which one is better?
+
+Let's try them out to understand the differences and choose the one we prefer.
+
+```ruby
+irb(main):009> include Sinlog::LogLambdaExt
+# It provides log_dbg, log_info, log_warn, log_err, log_fatal, log_unk
+# We can call them using .tap(&log_dbg) or .then(&log_dbg).
+
+irb(main):010> "debug".tap(&log_dbg)
+irb(main):011> "information".tap(&log_info)
+
+# Note: Here we use log_warn, not log_warning
+irb(main):012> "warning".tap(&log_warn)
+
+irb(main):013> "error".tap(&log_err)
+irb(main):014> "fatal".tap(&log_fatal)
+irb(main):015> "unknown".tap(&log_unk)
+```
+
+```ruby
+# Here is a more complex example
+irb(main):016> require 'pathname'
+
+irb(main):017> Pathname('lib/lambda.rb').tap do
+    "Filename: #{it}".then(&log_info)
+    "size: #{
+      it
+        .tap{ '⚠️ Getting file size might fail'.then(&log_warn) }
+        .size
+    }".then(&log_info)
+end
+```
+
+<img src="../assets/img/LogLambdaExt.jpg" alt="LogLambdaExt" style="width: 90%; height: 90%">
+
+LogLambdaExt provides:
+
+- log_dbg
+- log_info
+- log_warn
+- log_warning (same as log_warn, just a different name)
+- log_wng (same as log_warn, just a different name)
+- log_err
+- log_fatal
+- log_unk
+
+### Classic Method Call
+
+If you don't like lambdas, you can try the classic method call!
+
+First, run `irb` to enter the Ruby REPL, then follow these steps:
+
+```ruby
+irb(main):001> require 'sinlog'
+
+irb(main):002> log = Sinlog.instance.logger
+
+irb(main):003> log.debug 'debug'
+irb(main):004> log.info 'information'
+irb(main):005> log.warn 'warning'
+irb(main):006> log.error 'error'
+irb(main):007> log.fatal 'fatal'
+irb(main):008> log.unknown 'unknown'
+```
+
+Sinlog.instance.logger provides methods from Ruby's standard library logger.
+
+The most common ones are:
+
+- debug
+- info
+- warn
+- error
+- fatal
+- unknown
+
+## Advanced
+
+After trying it out ourselves, we have a basic understanding of `sinlog`.  
+In most cases, knowing its basic usage is sufficient.
+
+If you're interested, let's continue exploring together.
+
+### Real World Example
+
+In the real world, our program might look like this:
+
+```ruby
+require 'sinlog'
+
+class EpubProcessor
+  def initialize(epub_file, logger = nil)
+    @epub = epub_file
+    @logger = logger || Sinlog.instance.tap { it.fetch_env_and_update_log_level("XX_LOG") }.logger
+    @logger.debug "EpubProcessor class initialization completed."
+  end
+end
+```
+
+We might define a class's `@logger` instance variable and allow for a custom logger.
+
+Simply put, we might configure the logger more finely.
+
+In the following content, we will explore how to perform "more fine-grained configuration."
+
+### Log Levels
+
+Log levels from low to high are:
+
+- debug = 0
+- info = 1
+- warn = 2
+- error = 3
+- fatal = 4
+- unknown = 5
+
+```ruby
+p Sinlog::LV
+# => {debug: 0, info: 1, warn: 2, error: 3, fatal: 4, unknown: 5}
+
+# Change the log level to warn
+log = Sinlog.instance.logger.tap { it.level = Sinlog::LV[:warn] }
+# Or:
+# log = Sinlog.instance.logger.tap { it.level = 2 }
+
+log.error "This message will be displayed! Lower level WARN (2) will display higher level ERROR (3) logs."
+log.info "This message will not be displayed! Higher level WARN (2) will not display lower level INFO (1) logs."
+```
+
+- The lower the log level, the more detailed the content displayed.
+- Lower levels **will** display higher level logs.
+- Higher levels **will not** display lower level logs.
+
+### Environment Variables
+
+In the real world, for client applications, the end users are typically regular users.  
+To allow them to configure `log.level` directly, we can use environment variables.
+
+> Using environment variables is simple and efficient.
+
+By default, Sinlog will attempt to read the value of the environment variable `RUBY_LOG`.
+
+It essentially calls the function `fetch_env_and_update_log_level(env_name = 'RUBY_LOG')`.
+
+- If the environment variable does not exist, it uses `debug(0)`.
+- If the environment variable exists but is empty, it uses `unknown(5)`.
+- If the environment variable's value is invalid, it uses `unknown(5)`.
+
+We can set the environment variable using POSIX-sh, and then the logger will automatically set the log level to `warn` (the value of `RUBY_LOG`) during initialization.
+
+```sh
+# Possible values: debug, info, warn, error, fatal
+export RUBY_LOG=warn
+```
+
+If you don't want to use the default `RUBY_LOG` environment variable and prefer to use the value of `XX_CLI_LOG`, you can do it like this:
+
+POSIX-sh:
+
+```sh
+export XX_CLI_LOG=info
+```
+
+Ruby:
+
+```ruby
+logger = Sinlog.instance.tap { it.fetch_env_and_update_log_level("XX_CLI_LOG") }.logger
+
+logger.debug "This message will not be displayed because the current log level is INFO(1)."
+logger.info "Hello!"
+```
+
+### Log Output Device/Path
+
+By default, Sinlog outputs to `STDERR`.
+
+If you need to customize the log output path, you can call the logger's `reopen` method.
+
+```ruby
+# Logs will be output to the file a.log
+log = Sinlog.instance.logger.tap { it.reopen("a.log") }
+
+log.error "What happened! QuQ"
+```
+
+OR:
+
+```ruby
+log = Sinlog.instance.logger
+log.reopen("a.log")
+
+log.error "What happened! QuQ"
+```
+
+### Other Logger Methods
+
+In addition to `.reopen` and `.level`, we can also call other methods from Ruby's standard library logger on `Sinlog.instance.logger`.
+
+### Notes
+
+Sinlog uses the Singleton pattern, meaning the entire program will share the same instance (logger).
+
+Modifying Sinlog in class A of the same program will affect Sinlog in class B.
+
+## Side Note
+
+This is the first Ruby gem I have released.  
+The API might not fully adhere to idiomatic Ruby usage, so I appreciate your understanding.
+
+## License
+
+[MIT License](../License)

data/lib/init.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# 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)
+    fetch_env_and_update_log_level
+    @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
+
+  # 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.fetch_env_and_update_log_level("XX_LOG") }.logger
+  #
+  #   logger.debug "This message will not be displayed because the current log level is info"
+  #   logger.info "Hello!"
+  def fetch_env_and_update_log_level(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/lambda.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/MissingCopEnableDirective, Style/ClassVars
+
+class Sinlog
+  # Module to simplify logger calls using lambda expressions.
+  #
+  # The following methods define lambda expressions for different log levels.
+  # These lambdas can be used to log messages at the corresponding log level.
+  module LogLambdaExt
+    @@_sinlog_lambda_ext_logger_ = Sinlog.instance.logger
+
+    # Debug Logging
+    #
+    # Example:
+    #
+    #   require 'sinlog'
+    #   include Sinlog::LogLambdaExt
+    #
+    #   'Debug Message'.then(&log_dbg)
+    #
+    #   cmd = %w[ls -l -h]
+    #   "cmd_arr: #{cmd}".tap(&log_dbg)
+    def log_dbg
+      ->(msg) { @@_sinlog_lambda_ext_logger_.debug(msg) }
+    end
+
+    # Info(a.k.a. Information) Logging
+    #
+    # Example:
+    #
+    #   require 'pathname'
+    #
+    #   Pathname('lib/lambda.rb').tap {
+    #       "Filename: #{it}".then(&log_info)
+    #       "size: #{it.size}".then(&log_info)
+    #   }
+    def log_info
+      ->(msg) { @@_sinlog_lambda_ext_logger_.info(msg) }
+    end
+
+    # Warning Logging
+    #
+    # Example:
+    #
+    #   arr = (0..256).to_a
+    #   'This array is too large'.then(&log_warn) if arr.length > 128
+    def log_warn
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+
+    # Warning Logging
+    #
+    # Same as `log_warn`
+    def log_warning
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+
+    # Warning Logging
+    #
+    # Same as `log_warn`
+    def log_wng
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+
+    # Error Logging
+    #
+    # Example:
+    #
+    #   'CLI error: You should pass the --url'.then(&log_err)
+    def log_err
+      ->(msg) { @@_sinlog_lambda_ext_logger_.error(msg) }
+    end
+
+    # Fatal error logging
+    #
+    # Example:
+    #
+    #   'Failed to open xxx'.then(&log_fatal)
+    def log_fatal
+      ->(msg) { @@_sinlog_lambda_ext_logger_.fatal(msg) }
+    end
+
+    # Example:
+    #
+    #   'Unknown'.then(&log_unk)
+    def log_unk
+      ->(msg) { @@_sinlog_lambda_ext_logger_.unknown(msg) }
+    end
+  end
+
+  # Similar to LogLambdaExt, but the lambda functions do not have the `log_` prefix.
+  # One important thing to note is that LambdaExt defines the `warning` function, not `warn`.
+  #
+  # The following methods define lambda expressions for different log levels.
+  # These lambdas can be used to log messages at the corresponding log level.
+  module LambdaExt
+    @@_sinlog_lambda_ext_logger_ = Sinlog.instance.logger
+
+    # Debug Logging
+    #
+    # Example:
+    #
+    #   require 'sinlog'
+    #   include Sinlog::LambdaExt
+    #
+    #   'Debug Message'.then(&dbg)
+    #
+    #   cmd = %w[ls -l -h]
+    #   "cmd_arr: #{cmd}".tap(&dbg)
+    def dbg
+      ->(msg) { @@_sinlog_lambda_ext_logger_.debug(msg) }
+    end
+
+    # Info(a.k.a. Information) Logging
+    #
+    # Example:
+    #
+    #   require 'pathname'
+    #
+    #   Pathname('lib/lambda.rb').tap {
+    #       "Filename: #{it}".then(&info)
+    #       "size: #{it.size}".then(&info)
+    #   }
+    def info
+      ->(msg) { @@_sinlog_lambda_ext_logger_.info(msg) }
+    end
+
+    # Warning Logging
+    #
+    # Example:
+    #
+    #   arr = (0..1024).to_a
+    #   'This array is too large'.then(&warning) if arr.length > 128
+    def warning
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+
+    # Warning Logging
+    #
+    # Same as `warning`
+    def wng
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+
+    # Error Logging
+    #
+    # Example:
+    #
+    #   'CLI error: You should pass the --url'.then(&err)
+    def err
+      ->(msg) { @@_sinlog_lambda_ext_logger_.error(msg) }
+    end
+
+    # Fatal error logging
+    #
+    # Example:
+    #
+    #   'Failed to open xxx'.then(&fatal)
+    def fatal
+      ->(msg) { @@_sinlog_lambda_ext_logger_.fatal(msg) }
+    end
+
+    # Unknown(log-level) logging
+    #
+    # Example:
+    #
+    #   'Unknown'.then(&unk)
+    def unk
+      ->(msg) { @@_sinlog_lambda_ext_logger_.unknown(msg) }
+    end
+  end
+
+  # Defines the `warn` lambda expression
+  module LambdaWarnExt
+    @@_sinlog_lambda_ext_logger_ = Sinlog.instance.logger
+    # Warning Logging
+    #
+    # Same as `LambdaExt.warning`
+    def warn
+      ->(msg) { @@_sinlog_lambda_ext_logger_.warn(msg) }
+    end
+  end
+end

data/lib/sinlog/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Sinlog
+  VERSION = '0.0.1'
+end

data/lib/sinlog.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Usage:
+#
+#   require 'sinlog'
+#
+#   logger = Sinlog.instance.logger
+#   logger.info "Information"
+#   logger.debug "This is a debug message"
+#
+# Read more: https://github.com/2moe/sinlog-gem
+
+require_relative 'sinlog/version'
+require 'singleton'
+require 'logger'
+
+require_relative 'init'
+require_relative 'lambda'

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: sinlog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- 2moe
+bindir: bin
+cert_chain: []
+date: 2025-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A very, very simple singleton logger with colored log levels.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- License
+- docs/Readme-zh.md
+- docs/Readme.md
+- lib/init.rb
+- lib/lambda.rb
+- lib/sinlog.rb
+- lib/sinlog/version.rb
+homepage: https://github.com/2moe/sinlog-gem
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: colorful singleton logger
+test_files: []