tiny_log 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85cff9236f798df629886d40366c8a673ea208af89d7b37bea42038ea228e030
-  data.tar.gz: bf24cddc2ebf348ac713c0a066731fb1b2ce296db588eb77388ac920899c6a79
+  metadata.gz: 9e5e2cc1eee03fc86a34571b2fb6e55a080162bb3ac6b9598bbb34f0ef491afb
+  data.tar.gz: b68b82266ca779f4b83e700ca1e13314255a5ad481951b37d54a406c1aa715ba
 SHA512:
-  metadata.gz: 8a77fd0f56106ddedd77e036643cfeff75d3c5a36d7034255e8b766ecd419ece90e7611ef183606e43c2fd8ddd2b5eabd1122d8706ac52057543ef9d4729526c
-  data.tar.gz: 2be85ce2aa21c78ecf995b7853937ad1517b0468ff4c3b450b0fa9c1d3dd5ad0cc1efe8a86afadba97848c5f186bf4ceadc7e5ef4baa5aacc77c15616652b6a8
+  metadata.gz: d110256b17ab42ebf1d4acde5dd10c981ad7889245dd37ae0e38e4b890e5a46a3224459e87491aac210ea7de88ff0979e4f14c21bc18e74db1659afe33febf82
+  data.tar.gz: 00c580ecfdecb2a8882264ed92b8d4f1cc80631fa9e0a3648eedd6bae9581257d0148110f116c757c50857dfe3249dfd10472c64d312e6b55606065527a7cb3f

data/lib/tiny_log.rb

@@ -16,19 +16,42 @@ 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
-  def initialize(filename=nil)
+  # 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
+  # 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
 
   # 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.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies: []
 description: a tiny logger with almost no features
 email: jefflunt@gmail.com