tiny_log 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15005e17d6f5c9e590ad8068d114a838e6cb3e7a89a0cd4d79198996d53f0a7f
-  data.tar.gz: ccd7c0a3ae7f80550055465e436d8b7ebce4ffab922ead8fff8f886373b8b15a
+  metadata.gz: 29bbda4af6bbfaa0b413cecb8f148633de78393f69168d4a287517573dbd3ee6
+  data.tar.gz: d4d85673432ea22a5f2a248c4d75497eafae8acd28a3068d294dbe69c1abeef9
 SHA512:
-  metadata.gz: 17d8cad422dce69112a591b170cfe5d4d5ddaf4e8d421466426d5fe01f4b5a0cf0acb3970baeaa170957c1274af2ca42715fd0c4513fc6521febdc1b24664946
-  data.tar.gz: 8b97be546678bb91417410004a64c41885b6e83b49c942d50389095d809b6a3c1a886870db08e1d7f3087564c06400e899f250c51a7107c1deb49d20ec967ced
+  metadata.gz: 81697f49eea9ed19a2ad733253e08c193cde95605ddaaab2c2e7e3c27fd83838f2dd7720a47d23e47ac3be9830da1730033d1c54f29041a12479b94171c70e5e
+  data.tar.gz: 3501862caab10809686c86c1be81ee9f55305852b74a699709275daa60071c118c4506446e863caac8438762f3fb3b100c17782176c45d3eb8c5679fe6a65b4f

data/lib/tiny_log.rb

@@ -7,7 +7,7 @@ require 'time'
 # - the log message
 #
 # Ex:
-#   l = Log.new
+#   l = TinyLog.new
 #   l.erro('hi there')
 #   l.erro('hi there')
 #   2022-11-18T01:26:37.086295Z  92967 ERRO hi there
@@ -16,26 +16,50 @@ class TinyLog
   # filename: the I/O stream to send log messages to
   #   if unspecified, will default to $stdout
   #   if specified, attempts to open a file with the specified name to append to
-  # buffered: whether or not to buffer log output
+  # buffering: whether or not to buffer log output
   #   true, or not specified: log buffering is enabled
   #   false: log buffering is disabled - most useful for dev/test environments
   #     where you want to watch output in realtime
-  def initialize(filename=nil, buffering=true)
+  # background_thread: whether logging should be done in a background Thread
+  #   true, or not specified, use a Thread to write to the log every 5 seconds
+  #   false, write to the log immediately
+  def initialize(filename: nil, buffering: true, background_thread: true)
     @buffering = !!buffering
     @io = filename.is_a?(String) ? File.open(filename, 'a') : $stdout
+
+    if background_thread
+      @msg_queue = Queue.new
+      @background_thread = Thread.new do |t|
+        loop do
+          @msg_queue
+            .length
+            .times{ @io.puts @msg_queue.shift }
+          sleep 5
+        end
+      end
+    end
+  end
+
+  # flushes the underlying IO object; especially useful when buffering is
+  # enabled, or when you're exiting the application.
+  def flush
+    @io.flush
+
+    nil
   end
 
   # the clever bit that annotates the log message with a log level and UTC
   # timestamp
   def method_missing(prefix, *msgs)
-    msgs.each do |m|
-      m.to_s.lines.each do |l|
-        @io.puts "#{Time.now.utc.iso8601(6)} #{Process.pid.to_s.rjust(6)} #{prefix.to_s.upcase} #{l}"
-      end
-    end
-
+    msgs.each{|m| _build_lines(m).each{|l| @background_thread ? @msg_queue << l : @io.puts(l) } }
     @io.flush unless @buffering
 
     nil
   end
+
+  def _build_lines(m)
+    m.to_s.lines.map do |l|
+      "#{Time.now.utc.iso8601(6)} #{Process.pid.to_s.rjust(6)} #{prefix.to_s.upcase} #{l}"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_log
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-19 00:00:00.000000000 Z
+date: 2023-07-03 00:00:00.000000000 Z
 dependencies: []
 description: a tiny logger with almost no features
 email: jefflunt@gmail.com