rb_falcon_logger 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0abbcdd59c340b7fb01541a2d0fe4246a6335e79be9a3ea88644c9859f085d
-  data.tar.gz: 89cf30440ae1d50e97a8bcf621ab07799eed2d3fbfc0ef742a2ce25801e0d282
+  metadata.gz: d580d23f926e2754b3faff8493637860980164d80e84c71d5f0673b032d35253
+  data.tar.gz: 3b344b9be5ba10542b22188cabf1db9ddf9bf6c2ffe9a6b79774de1e8fcd0907
 SHA512:
-  metadata.gz: 1a57f92c007fbc4115c789c18d2643920b0bdd8a46b8960b29dffc095ba97898c13c93858c5d5be3557edf077044c0f9ccfa75ea37fab6459ec0de7501fe3c95
-  data.tar.gz: 7669f2137c27f6aeb465aca9fc1c1a6ef2d9dd5018421df9d426c7dc76b8ff98d4e189749dcc971ed749505c8c05409868045911bec0725c1ff67bdb3fcc16fe
+  metadata.gz: 4fb74ebd819ca38ddaf44953388e0dd4c9aae95d589a5f46e4241693018e498ec43a5ce7a6f9355f38b18112c965b6df647658b69e5ce7591500191edaa6bd4d
+  data.tar.gz: 24f527bd3d2f31989a5ef2066f8dc9241f842450b674dd8f4befe4ce89119f8ccd840d4324ca53cb75bb03e940a99a41b0fd5786f64cc21199c2e38a953e8e6b

data/README.md

@@ -12,8 +12,16 @@ see src/logger_tester.rb for a full example
 
 Use doit script to run the logger.
 
-TODO logger_tester args
-TODO multithreaded_tester
+```text
+./doit           # (default) normal mode
+./doit normal
+./doit immediate
+./doit ut
+./doit mock      # same as ut mode
+./doit null      # no output
+
+./doit thread    # runs multiple loggers in multiple threads
+```
 
 ## parameters and functions
 
@@ -30,9 +38,10 @@ Use these on the logger creation: ```@log = FalconLogger(path: etc, max_entries:
 * use ```@log.save``` to force the queue to be saved. Generally not recommended.
 * use ```@log.term``` to clear out the queue and gracefully end the background thread
 
-There are 3 modes: ```FalconLogger(mode: 'normal')```
+There are 4 modes: ```FalconLogger(mode: 'normal')```
 
 * nil or 'normal': (default) writes a line to stdout or the file. See below for outputs
+* 'immediate': does not use a bg thread
 * 'ut' or 'mock': useful in UTs. These do not write to stdout or to a file.
     * The lines are saved in an internal list accessible by: ```@log.ut_lines```.
     * Use ```@log.ut_clear``` or ```@log.ut_lines = []``` to empty it.

data/lib/gem_source/logger.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 require 'json'
 
-# import atexit
-# import threading
-
 # -------------------
 ## Sample gem source
 class FalconLogger
@@ -118,6 +115,8 @@ class FalconLogger
         @fp = File.open(@path, 'w', encoding: 'UTF-8')
       end
       _init_thread
+    elsif mode == 'immediate'
+      _set_log_it_immediate_fn
     elsif %w[ut mock].include?(mode)
       _set_log_it_ut_fn
     elsif mode == 'null'
@@ -210,7 +209,20 @@ class FalconLogger
       raise(ArgumentError, "Unknown format: \"#{form}\", choose \"elapsed\", \"prefix\" or \"none\"")
     end
 
-    _set_log_it_ut_fn if %w[ut mock].include?(@logging_mode)
+    if %w[immediate].include?(@logging_mode)
+      _set_log_it_immediate_fn
+    elsif %w[ut mock].include?(@logging_mode)
+      _set_log_it_ut_fn
+    end
+  end
+
+  # --------------------
+  ## write the line to stdout
+  #
+  # @return nil
+  def _set_log_it_immediate_fn
+    @fp     = $stdout
+    @log_it = method(:_log_it_immediate)
   end
 
   # --------------------
@@ -273,6 +285,21 @@ class FalconLogger
   #
   # @return nil
   def term
+    if @logging_mode == 'normal'
+      term_normal
+    else
+      # for immediate do a final flush
+      # other modes don't need it, but it won't harm anything
+      $stdout.flush
+    end
+  end
+
+  # --------------------
+  ## terminate in normal mode
+  # stop the thread, save any remaining line in the internal queue
+  #
+  # @return nil
+  def term_normal
     begin
       # since this will be called during atexit() handling,
       # stdout and/or file can be closed. Protect against this case.
@@ -282,7 +309,7 @@ class FalconLogger
     end
 
     @finished = true
-    @thread.join(5.0) unless @thread.nil? || !@thread.alive?
+    @thread.join(2.0) unless @thread.nil? || !@thread.alive?
   end
 
   # --------------------
@@ -302,6 +329,17 @@ class FalconLogger
     @queue.push(info)
   end
 
+  # --------------------
+  ## since it's immediate mode, write the logging info to stdout and flush stdout
+  #
+  # @param info  the line info
+  # @return nil
+  def _log_it_immediate(info)
+    write_line(info)
+    # ensure to flush after every line/dot
+    $stdout.flush
+  end
+
   # --------------------
   ## since it's ut mode and no prefixes, add the line to ut_lines
   #
@@ -383,9 +421,9 @@ class FalconLogger
   # --------------------
   ## since it's null mode, ignore the line
   #
-  # @param info  (ignored)
+  # @param _info  (ignored)
   # @return nil
-  def _log_it_null(info)
+  def _log_it_null(_info)
     # logging ignored
   end
 
@@ -687,102 +725,107 @@ class FalconLogger
       # :nocov:
 
       # get the next tuple: (always_print, verbose, dts, prefix, args)
-      tuple        = @queue.pop
-      always_print = tuple[0]
-      verbose      = tuple[1]
-      dts          = tuple[2]
-      prefix       = tuple[3]
-      args         = tuple[4]
-      count        -= 1
-
-      # uncomment to debug
-      # puts("#{always_print} #{verbose} '#{prefix}'  #{dts}  '#{args}'")
-
-      # not verbose and ok not to print
-      next unless verbose || always_print
+      tuple = @queue.pop
+      count -= 1
+      write_line(tuple)
+    end
 
-      if args[0].nil? && prefix == '.'
-        # dots used to log waiting periods, so okay to call fn
-        _handle_dots
-        next
-      end
+    # uncomment to debug
+    # @fp.close
 
-      # at this point, not a dot
+    # flush lines to stdout/file; protect with except in case
+    begin
+      @fp.flush
+    rescue IOError
+      # coverage: rare case: if stdout/file is closed this will throw an exception
+    end
+  end
 
-      # last call was a dot, so reset and print a newline ready for the new log line
-      if @dots != 0
-        @dots = 0
-        @fp.write("\n")
-        @runner_cfg.copy_from(@backup_cfg)
-      end
+  # -------------------
+  def write_line(tuple)
+    always_print = tuple[0]
+    verbose      = tuple[1]
+    dts          = tuple[2]
+    prefix       = tuple[3]
+    args         = tuple[4]
 
-      # print the full DTS requested by the user
-      if args[0].nil? && prefix.nil?
-        # rare request, so okay to call fn
-        _handle_full_dts(dts)
-        next
-      end
+    # uncomment to debug
+    # puts("#{always_print} #{verbose} '#{prefix}'  #{dts}  '#{args}'")
 
-      # print with no prefix or elapsed time
-      if @log_format == LogFormat::NONE
-        line = args.join(' ')
-        @fp.write(line)
-        @fp.write("\n")
-        next
-      end
+    # not verbose and ok not to print
+    return unless verbose || always_print
 
-      # print with the prefix, but no elapsed time
-      if @log_format == LogFormat::PREFIX
-        line = args.join(' ')
-        if prefix.nil?
-          msg = line # raw line
-        else
-          msg = format('%-4s %s', prefix, line)
-        end
-        @fp.write(msg)
-        @fp.write("\n")
-        next
-      end
+    if args[0].nil? && prefix == '.'
+      # dots used to log waiting periods, so okay to call fn
+      _handle_dots
+      return
+    end
 
-      # at this point, mode is LogFormat.ELAPSED
+    # at this point, not a dot
 
-      # approximately once an hour, restart the time period
-      elapsed = Time.at(dts - @start_time)
-      if elapsed.to_f > 3600.0
-        # rare, so okay to call fn
-        # display the time at the moment the log line was saved
-        _handle_full_dts(dts)
+    # last call was a dot, so reset and print a newline ready for the new log line
+    if @dots != 0
+      @dots = 0
+      @fp.write("\n")
+      @runner_cfg.copy_from(@backup_cfg)
+    end
 
-        # recalc the elapsed time, should be 0
-        # add the small value for round-off issues
-        elapsed = Time.at(dts - @start_time) #  + 0.0001)
-      end
+    # print the full DTS requested by the user
+    if args[0].nil? && prefix.nil?
+      # rare request, so okay to call fn
+      _handle_full_dts(dts)
+      return
+    end
 
-      # print prefix and elapsed time
+    # print with no prefix or elapsed time
+    if @log_format == LogFormat::NONE
       line = args.join(' ')
+      @fp.write(line)
+      @fp.write("\n")
+      return
+    end
 
-      # log the line
+    # print with the prefix, but no elapsed time
+    if @log_format == LogFormat::PREFIX
+      line = args.join(' ')
       if prefix.nil?
-        msg = line
+        msg = line # raw line
       else
-        t_str = _get_elapsed_str(elapsed)
-        msg   = format('%s %-4s %s', t_str, prefix, line)
+        msg = format('%-4s %s', prefix, line)
       end
-
-      # assume @fp is not closed
       @fp.write(msg)
       @fp.write("\n")
+      return
     end
 
-    # uncomment to debug
-    # @fp.close
+    # at this point, mode is LogFormat.ELAPSED
 
-    # flush lines to stdout/file; protect with except in case
-    begin
-      @fp.flush
-    rescue IOError
-      # coverage: rare case: if stdout/file is closed this will throw an exception
+    # approximately once an hour, restart the time period
+    elapsed = Time.at(dts - @start_time)
+    if elapsed.to_f > 3600.0
+      # rare, so okay to call fn
+      # display the time at the moment the log line was saved
+      _handle_full_dts(dts)
+
+      # recalc the elapsed time, should be 0
+      # add the small value for round-off issues
+      elapsed = Time.at(dts - @start_time) #  + 0.0001)
+    end
+
+    # print prefix and elapsed time
+    line = args.join(' ')
+
+    # log the line
+    if prefix.nil?
+      msg = line
+    else
+      t_str = _get_elapsed_str(elapsed)
+      msg   = format('%s %-4s %s', t_str, prefix, line)
     end
+
+    # assume @fp is not closed
+    @fp.write(msg)
+    @fp.write("\n")
   end
 
   # --------------------

data/lib/version.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 ## current version
-VERSION = '0.1.1'
+VERSION = '0.3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_falcon_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - J. Arrizza
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
+date: 2025-09-06 00:00:00.000000000 Z
 dependencies: []
 description: fast logger with multiple modes and formats
 email: cppgent0@gmail.com