log_redux 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1168023cc9b033774087cf359edc109875b643bdee832eb7b80c23acb5c85fd9
+  data.tar.gz: 6b6af03c951be721b0dd7a879bb2e3acf4fae3b4f6f6ca385ee0133aca777b04
+SHA512:
+  metadata.gz: 4ef5ead8bd4bf488748bef0ca1eef73f917b22c3a90b1c162443bb6d317993cebe454a74114f15d1a789a1bd3401d18893fb63db26b055640fe93441cbc03a8f
+  data.tar.gz: 8390a6092cd6aac4299e1c9ac99ab0dbb58180719d72b0e7348f932cb1222f75ba5ddf5fa22966ea71c34eb8fcee3a0f2f21d2fb3611fdf534ae83873a53f294

data/lib/log_redux/logger.rb

@@ -0,0 +1,126 @@
+require_relative 'logger_helpers'
+
+module LogRedux
+  class Logger
+    attr_reader :output_filename, :log_file, :history
+    attr_accessor :color, :timestamp, :filename, :line_number, :track
+
+    def initialize(output_filename = $stderr, color: true, timestamp: true, filename: true, track: false)
+      if output_filename.nil? || (!output_filename.is_a?(String) && !check_valid_stdio(output_filename))
+        raise LoggerError, 'invalid log file'
+      end
+
+      @output_filename = output_filename
+      @color = color
+      @timestamp = timestamp
+      @filename = filename
+      @track = track
+      @history = []
+
+      @log_file = check_valid_stdio(output_filename) ? output_filename : File.open(output_filename, 'a+')
+    end
+
+    def log(level, msg: nil)
+      assert_log_level(level)
+
+      level_str = level.to_s
+      time = Time.now.strftime('%H:%M:%S')
+      file_line = caller(1).last.split(':')[0..1]
+      filename = file_line[0]
+      line_number = file_line[1]
+
+      output = if @color
+                 [
+                   @timestamp ? "#{COLORS[:GREY]}#{time}" : nil,
+                   "#{COLORS[level.to_sym]}#{level_str}#{@filename ? '' : ':'}",
+                   @filename ? "#{COLORS[:GREY]}#{file_line.join(':')}:" : nil,
+                   "#{COLORS[:WHITE]}#{msg}#{COLORS[:RESET]}"
+                 ].compact.join(' ')
+               else
+                 [
+                   @timestamp ? "#{time}" : nil,
+                   "#{level_str}#{@filename ? '' : ':'}",
+                   @filename ? "#{file_line.join(':')}:" : nil,
+                   "#{msg}"
+                 ].compact.join(' ')
+               end
+
+      @log_file.puts output
+
+      save_entry(level, msg, time, filename, line_number, output) if @track
+
+      output
+    end
+
+    def trace(msg)
+      log(:TRACE, msg: msg)
+    end
+
+    def debug(msg)
+      log(:DEBUG, msg: msg)
+    end
+
+    def info(msg)
+      log(:INFO, msg: msg)
+    end
+
+    def warn(msg)
+      log(:WARN, msg: msg)
+    end
+
+    def error(msg)
+      log(:ERROR, msg: msg)
+    end
+
+    def fatal(msg)
+      log(:FATAL, msg: msg)
+    end
+
+    def [](index)
+      raise LoggerError, 'tracking logs is disabled' unless @track
+
+      @history[index][:formatted]
+    end
+
+    def first
+      raise LoggerError, 'tracking logs is disabled' unless @track
+
+      @history.first[:formatted]
+    end
+
+    def last
+      raise LoggerError, 'tracking logs is disabled' unless @track
+
+      @history.last[:formatted]
+    end
+
+    def close
+      raise LoggerError, 'cannot close a Standard IO file' if check_valid_stdio(@log_file)
+
+      @log_file.close
+    end
+
+    private
+
+    def check_valid_stdio(file)
+      return true if [$stdout, $stderr].include?(file)
+
+      false
+    end
+
+    def assert_log_level(level)
+      raise LoggerError, "invalid log level `#{level}`" unless COLORS.keys.include?(level.to_sym)
+    end
+
+    def save_entry(level, msg, time, filename, line_number, output)
+      @history << {
+        level: level,
+        time: time,
+        filename: filename,
+        line: line_number,
+        msg: msg,
+        formatted: output
+      }
+    end
+  end
+end

data/lib/log_redux/logger_helpers.rb

@@ -0,0 +1,15 @@
+module LogRedux
+  COLORS = {
+    TRACE: "\e[94m",
+    DEBUG: "\e[36m",
+    INFO: "\e[32m",
+    WARN: "\e[33m",
+    ERROR: "\e[31m",
+    FATAL: "\e[35m",
+    GREY: "\e[90m",
+    WHITE: "\e[37m",
+    RESET: "\e[0m"
+  }
+
+  class LoggerError < StandardError; end
+end

data/lib/log_redux.rb

@@ -0,0 +1,3 @@
+require_relative 'log_redux/logger'
+
+module LogRedux; end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: log_redux
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Ualace Henrique
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-28 00:00:00.000000000 Z
+dependencies: []
+description: A simple but rather customizable logging library for Ruby
+email: ualacehenrique@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/log_redux.rb
+- lib/log_redux/logger.rb
+- lib/log_redux/logger_helpers.rb
+homepage: https://github.com/UalaceCafe/log_redux
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: LogRedux
+test_files: []