sinlog 0.0.2 → 0.0.3

data/lib/sinlog.rb

@@ -1,18 +1,49 @@
 # frozen_string_literal: true
 
-# Usage:
+# == Logging Modules Overview
 #
-#   require 'sinlog'
+# The following modules provide different ways to add logging capabilities:
 #
-#   logger = Sinlog.instance.logger
-#   logger.info "Information"
-#   logger.debug "This is a debug message"
+# * Loggable      : A mixin module. Include it in your class to add logging methods with the `log_` prefix.
+# * LogExt        : A refinement. Activate it with `using` to add logging methods with the `log_` prefix.
+# * LogShortExt   : A refinement. Similar to LogExt, but methods omit the `log_` prefix.
+#
+# === Comparison Table
+#
+#  Module         | Type        | Activation    | Method Naming
+#  -------------- | ----------  | ------------  | -------------------------
+#  Loggable       | Mixin       | include       | log_dbg, log_info, etc.
+#  LogExt         | Refinement  | using         | log_dbg, log_info, etc.
+#  LogShortExt    | Refinement  | using         | dbg, info, warn, err, fatal, unk
+#
+# == Examples
+#
+# === Classic (neither mixin nor refinement)
+#
+#     require 'sinlog'
+#
+#     log = Sinlog.logger
+#     log.info "Information"
+#     log.debug "This is a debug message"
+#
+# === Mixin
+#
+#     require 'sinlog'
+#     include Sinlog::Loggable
+#     "Hello".log_info
+#
+# === Refinement
+#
+#     require 'sinlog'
+#     using Sinlog::LogShortExt
+#     "Hello".info
 #
 # Read more: https://github.com/2moe/sinlog-gem
+class Sinlog; end
 
 require_relative 'sinlog/version'
-require 'singleton'
-require 'logger'
 
-require_relative 'init'
-require_relative 'lambda'
+require_relative 'sinlog/init'
+require_relative 'sinlog/loggable'
+require_relative 'sinlog/log_ext'
+require_relative 'sinlog/log_short_ext'

data/rbi/sinlog/init.rbi

@@ -0,0 +1,34 @@
+# 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

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

data/rbi/sinlog/log_short_ext.rbi

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

data/rbi/sinlog/loggable.rbi

@@ -0,0 +1,25 @@
+# rubocop:disable Style/FrozenStringLiteralComment
+# rubocop:disable Style/Documentation
+# typed: true
+
+class Sinlog
+  module Loggleable
+    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

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sinlog
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - 2moe
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A very, very simple singleton logger with colored log levels.
 executables: []
@@ -17,16 +17,22 @@ files:
 - License
 - docs/Readme-zh.md
 - docs/Readme.md
-- lib/init.rb
-- lib/lambda.rb
 - lib/sinlog.rb
+- lib/sinlog/init.rb
+- lib/sinlog/log_ext.rb
+- lib/sinlog/log_short_ext.rb
+- lib/sinlog/loggable.rb
 - lib/sinlog/version.rb
+- rbi/sinlog/init.rbi
+- rbi/sinlog/log_ext.rbi
+- rbi/sinlog/log_short_ext.rbi
+- rbi/sinlog/loggable.rbi
+- rbi/sinlog/version.rbi
 homepage: https://github.com/2moe/sinlog-gem
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/2moe/sinlog-gem
-  source_code_uri: https://github.com/2moe/sinlog-gem
 rdoc_options: []
 require_paths:
 - lib
@@ -34,14 +40,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
 summary: colorful singleton logger
 test_files: []

data/lib/lambda.rb

@@ -1,184 +0,0 @@
-# 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