simple_cloud_logging 1.2.2 → 1.2.4

data/examples/no-colors.rb

@@ -0,0 +1,29 @@
+# overwrite the instance methods green, red, blue and yellow of the class String to make them non-effect.
+# if you require the colorize gem after the logger setup, colors will be activated again.
+
+require_relative '../lib/simple_cloud_logging'
+
+# create a logger
+l = BlackStack::LocalLogger.new("no-colors.log")
+
+BlackStack::Logger.set(
+    colorize: false,
+)
+
+begin
+    l.blank_line
+    l.logs "Looking for number 3... "
+    i = 0
+    while i < 6
+        l.logs "#{i}... " 
+        if i == 3
+            l.yes 
+        else
+            l.no 
+        end
+        i += 1
+    end
+    l.done
+rescue => e
+    l.error(e)
+end

data/examples/show_caller.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/simple_cloud_logging'
+
+# create a logger
+l = BlackStack::LocalLogger.new("show_caller.log")
+
+BlackStack::Logger.set(
+    show_nesting_caller: true,
+)
+
+begin
+    l.blank_line
+    l.logs "Looking for number 3... "
+    i = 0
+    while i < 6
+        l.logs "#{i}... " 
+        if i == 3
+            l.yes 
+        else
+            l.no 
+        end
+        i += 1
+    end
+    l.done
+rescue => e
+    l.error(e)
+end

data/examples/show_level.rb

@@ -0,0 +1,26 @@
+require_relative '../lib/simple_cloud_logging'
+
+# create a logger
+l = BlackStack::LocalLogger.new("show_level.log")
+
+BlackStack::Logger.set(
+    show_nesting_level: true,
+)
+
+begin
+    l.blank_line
+    l.logs "Looking for number 3... "
+    i = 0
+    while i < 6
+        l.logs "#{i}... " 
+        if i == 3
+            l.yes 
+        else
+            l.no 
+        end
+        i += 1
+    end
+    l.done
+rescue => e
+    l.error(e)
+end

data/lib/baselogger.rb

@@ -1,112 +1,264 @@
-module BlackStack
-  class BaseLogger
-    METHOD_LOG = 'log'
-    METHOD_LOGS = 'logs'
-    METHOD_LOGF = 'logf'  
-    METHODS = [METHOD_LOG, METHOD_LOGS, METHOD_LOGF]
-
-    attr_accessor :filename, :nest_level, :number_of_lines_in_current_level, :current_nest_level
-
-    def initialize_attributes()
-      self.nest_level = 0
-      self.current_nest_level = 0
-      self.number_of_lines_in_current_level = 0      
-    end
-    
-    def initialize(the_filename=nil)
-      self.filename = the_filename
-      self.initialize_attributes
-    end
-  
-    def reset()
-      self.initialize_attributes
-    end
-    
-    def log(s, datetime=nil)
-      t = !datetime.nil? ? datetime : Time.now 
-      ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
-      ltext = ltime + ": " + s + "\r\n"
-      print ltext
-      ltext
-    end
-  
-    def logs(s, datetime=nil)
-      t = !datetime.nil? ? datetime : Time.now 
-      ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
-
-      ltext = ""
-      self.nest_level += 1
-      self.number_of_lines_in_current_level = 0
-      
-      if self.current_nest_level != self.nest_level 
-        ltext += "\n"
-      end
-      
-      ltext += ltime + ": "
-
-      i=1
-      while (i<self.nest_level)
-        ltext += " > "
-        i+=1
-      end
-    
-      ltext += s
-                  
-      #File.open(self.filename, 'a') { |file| file.write(ltext) }
-      print ltext
-      
-      #
-      self.current_nest_level = self.nest_level
-
-      #
-      ltext
-    end
-
-    def logf(s, datetime=nil)
-      t = !datetime.nil? ? datetime : Time.now 
-      ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
-
-      ltext = ''
-      
-      if self.number_of_lines_in_current_level > 0
-        ltext = ltime + ": "
-        
-        i=1
-        while (i<self.nest_level)
-          ltext += " > "
-          i+=1
-        end
-      end # if self.number_of_lines_in_current_level == 0
-      
-      self.nest_level -= 1
-      self.number_of_lines_in_current_level += 1
-
-      ltext += s + "\n"
-
-      print ltext
-      
-      ltext
-    end
-
-    def release()
-      raise "This is an abstract method."
-    end
-
-    def done()
-      self.logf("done")
-    end
-
-    def error(e=nil)
-      self.logf("error") if e.nil?
-      self.logf("error: #{e.to_console}.") if !e.nil?
-    end  
-
-    def yes()
-      self.logf("yes")
-    end
-
-    def no()
-      self.logf("no")
-    end
-  end # class BaseLogger
+module BlackStack
+
+  module Logger
+    DEFAULT_MIN_SIZE = 10*1024*1024
+    DEFAULT_MAX_SIZE = 20*1024*1024
+    DEFAULT_SHOW_NESTING_LEVEL = false
+    DEFAULT_SHOW_NESTING_CALLER = false
+    DEFAULT_COLORIZE = true
+    DEFAULT_NESTING_ASSERTION = true
+
+    @@min_size = DEFAULT_MIN_SIZE
+    @@max_size = DEFAULT_MAX_SIZE
+    @@show_nesting_level = DEFAULT_SHOW_NESTING_LEVEL
+    @@show_nesting_caller = DEFAULT_SHOW_NESTING_CALLER
+    @@colorize = DEFAULT_COLORIZE
+    @@nesting_assertion = DEFAULT_NESTING_ASSERTION
+
+    def self.set(
+      min_size: DEFAULT_MIN_SIZE,
+      max_size: DEFAULT_MAX_SIZE,
+      show_nesting_level: DEFAULT_SHOW_NESTING_LEVEL,
+      show_nesting_caller: DEFAULT_SHOW_NESTING_CALLER,
+      colorize: DEFAULT_COLORIZE,
+      nesting_assertion: DEFAULT_NESTING_ASSERTION
+    )
+      err = []
+
+      # min_size must be a positive integer
+      err << "min_byes must be apositive integer." if !min_size.is_a?(Integer) || min_size.to_i < 0
+      err << "max_byes must be apositive integer." if !max_size.is_a?(Integer) || max_size.to_i < 0
+      err << "min_byes must be lower than max_size." if min_size.is_a?(Integer) && max_size.is_a?(Integer) && !(min_size < max_size)
+      err << "show_nesting_level must be a boolean." if ![true, false].include?(show_nesting_level)
+      err << "show_nesting_caller must be a boolean." if ![true, false].include?(show_nesting_caller)
+      err << "colorize must be a boolean." if ![true, false].include?(colorize)
+      err << "nesting_assertion must be a boolean." if ![true, false].include?(nesting_assertion)
+
+      @@min_size = min_size
+      @@max_size = max_size
+      @@show_nesting_level = show_nesting_level
+      @@show_nesting_caller = show_nesting_caller
+      @@colorize = colorize  
+      @@nesting_assertion = nesting_assertion
+
+      if !colorize
+        # overwrite the instance methods green, red, blue and yellow of the class String from inside the constructor of another class, to make them non-effect.
+        String.class_eval do
+          define_method(:green) do
+            self
+          end
+    
+          define_method(:red) do
+            self
+          end
+    
+          define_method(:blue) do
+            self
+          end
+    
+          define_method(:yellow) do
+            self
+          end
+        end
+      end
+    end
+
+    def self.min_size()
+      @@min_size
+    end
+
+    def self.max_size()
+      @@max_size
+    end
+
+    def self.show_nesting_level()
+      @@show_nesting_level
+    end
+
+    def self.show_nesting_caller()
+      @@show_nesting_caller
+    end
+
+    def self.colorize()
+      @@colorize
+    end
+
+    def self.nesting_assertion()
+      @@nesting_assertion
+    end
+  end # module Logger
+
+  class LogNestingError < StandardError
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+    def to_s
+      @message
+    end
+  end
+
+  class BaseLogger
+    NEWLINE = "\n\r"
+    attr_accessor :filename, :level, :level_children_lines, :level_open_callers
+
+    def initialize_attributes()
+      self.level = 0
+      self.level_children_lines = {}      
+      self.level_open_callers = {}
+  end
+    
+    def initialize(the_filename=nil)
+      self.filename = the_filename
+      self.initialize_attributes
+    end
+  
+    def reset()
+      self.initialize_attributes
+    end
+    
+    def log(s, datetime=nil)
+      t = !datetime.nil? ? datetime : Time.now 
+      ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
+      ltime += " - level #{self.level.to_s.blue}" if Logger.show_nesting_level
+      ltext = ltime + ": " + s + NEWLINE
+      # print
+      print ltext
+      # return
+      ltext
+    end
+  
+    def blank_line
+      self.log('')
+    end
+
+    def logs(s, datetime=nil)
+
+      # Nesting assertion:
+      # - How to find out from which line number the method was called in Ruby?
+      # - Referneces:
+      #   - https://stackoverflow.com/questions/37564928/how-to-find-out-from-which-line-number-the-method-was-called-in-ruby
+      #   - https://ruby-doc.org/core-2.2.3/Thread/Backtrace/Location.html
+#binding.pry if s == "Looking for number 3... "
+      caller = caller_locations(0..).last
+#binding.pry if s == '1... '
+#binding.pry if s == '4... '
+      # if the parent level was called from the same line, I am missing to close the parent.
+      if self.level_open_callers[self.level-1].to_s == caller.to_s
+        if Logger.nesting_assertion
+          raise LogNestingError.new("Log nesting assertion: You missed to close the log-level that you opened at #{caller.to_s}.")
+        end
+      else
+        self.level_open_callers[self.level] = caller.to_s
+      end
+
+      t = !datetime.nil? ? datetime : Time.now 
+      ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
+      ltime += " - level #{self.level.to_s.blue}" if Logger.show_nesting_level
+      ltime += " - caller #{caller.to_s.blue}" if Logger.show_nesting_caller
+
+#binding.pry if self.level>0
+      # start in a new line, if this line is the first child of the parent level has opened lines
+      ltext = ""
+      ltext += NEWLINE if self.level > 0 && self.level_children_lines[self.level].to_i == 0
+      ltext += ltime + ": "
+
+      # increase the number of children of the parent level
+      self.level_children_lines[self.level] = self.level_children_lines[self.level].to_i + 1
+
+      self.level += 1
+
+      i=1
+      while (i<self.level)
+        ltext += "> "
+        i+=1
+      end
+    
+      ltext += s
+                  
+      # print
+      print ltext
+      
+      # return
+      ltext
+    end
+
+    def logf(s, datetime=nil)
+      ltext = ""
+
+      # clear the caller who opened the level that I am closing
+      self.level_open_callers[self.level-1] = nil
+      
+      # if the parent level has children
+      if self.level_children_lines[self.level].to_i > 0
+        t = !datetime.nil? ? datetime : Time.now 
+        ltime = t.strftime("%Y-%m-%d %H:%M:%S").to_s
+        ltime += " - level #{self.level.to_s.blue}" if Logger.show_nesting_level
+  
+        ltext += "#{ltime}: "
+
+        i=1
+        while (i<self.level)
+          ltext += "> "
+          i+=1
+        end
+  
+      end
+
+      # since I am closing a level, set the number of children to 0
+      self.level_children_lines[self.level] = 0
+
+      # nesting assertion
+      if self.level <= 0
+        # force the level to 2, so I can use the loger to trace the error after raising the exceptiopn.
+        self.level = 1
+        # raise the exception
+        if Logger.nesting_assertion
+          raise LogNestingError.new("Log nesting assertion: You are closing 2 times the level started, or you missed to open that lavel, or you closed the another level in the middle 2 times.") 
+        end
+      end
+
+      self.level -= 1
+      ltext += s + NEWLINE 
+            
+      # print
+      print ltext
+      # return
+      ltext
+    end
+
+    def done(details: nil)
+      if details.nil?
+        self.logf("done".green)
+      else
+        self.logf("done".green + " (#{details.to_s})")
+      end
+    end
+
+    def skip(details: nil)
+      if details.nil?
+        self.logf("skip".yellow)
+      else
+        self.logf("skip".yellow + " (#{details.to_s})")
+      end
+    end
+
+    def error(e=nil)
+      self.logf("error".red) if e.nil?
+      self.logf("error: #{e.to_console}.".red) if !e.nil?
+    end  
+
+    def yes()
+      self.logf("yes".green)
+    end
+
+    def ok()
+      self.logf("ok".green)
+    end
+
+    def no()
+      self.logf("no".yellow)
+    end
+  end # class BaseLogger
 end # module BlackStack

data/lib/dummylogger.rb

@@ -1,27 +1,26 @@
-module BlackStack
-  require_relative './baselogger'
-  class DummyLogger < BlackStack::BaseLogger
-
-    # call the parent class to set the attributes
-    # call the save method to store the new attributes into the data file
-    def reset()
-      super
-    end
-
-    def log(s, datetime=nil)
-    end
-  
-    # 
-    def logs(s, datetime=nil)
-    end # def logs
-  
-    # 
-    def logf(s, datetime=nil)      
-    end # def logf
-
-    # 
-    def release()
-    end
-
-  end # class LocalLogger
+module BlackStack
+  class DummyLogger < BaseLogger
+
+    # call the parent class to set the attributes
+    # call the save method to store the new attributes into the data file
+    def reset()
+      super
+    end
+
+    def log(s, datetime=nil)
+    end
+  
+    # 
+    def logs(s, datetime=nil)
+    end # def logs
+  
+    # 
+    def logf(s, datetime=nil)      
+    end # def logf
+
+    # 
+    def release()
+    end
+
+  end # class LocalLogger
 end # module BlackStack

data/lib/locallogger.rb

@@ -1,38 +1,64 @@
-module BlackStack
-  require_relative './baselogger'
-  class LocalLogger < BlackStack::BaseLogger
-
-    # call the parent class to set the attributes
-    # call the save method to store the new attributes into the data file
-    def reset()
-      super
-      BlackStack::LocalLoggerFactory::save(self.filename, self)
-    end
-
-    def log(s, datetime=nil)
-      ltext = super(s, datetime)
-      File.open(self.filename, 'a') { |file| file.write(ltext) }
-      ltext
-    end
-  
-    # 
-    def logs(s, datetime=nil)
-      ltext = super(s, datetime)
-      File.open(self.filename, 'a') { |file| file.write(ltext) }
-      ltext
-    end # def logs
-  
-    # 
-    def logf(s, datetime=nil)      
-      ltext = super(s, datetime)
-      File.open(self.filename, 'a') { |file| file.write(ltext) }
-      ltext
-    end # def logf
-
-    # 
-    def release()
-      BlackStack::LocalLoggerFactory.release(self.filename)
-    end
-
-  end # class LocalLogger
+module BlackStack
+  class LocalLogger < BaseLogger
+
+    # call the parent class to set the attributes
+    # call the save method to store the new attributes into the data file
+    def reset()
+      super
+      BlackStack::LocalLoggerFactory::save(self.filename, self)
+    end
+
+    # store the min allowed bytes in the variable min
+    # store the max allowed bytes in the variable max
+    # get number of bytes of filename and store it the variable n
+    # if number of bytes (n) is higer than max, then truncate the first (max-min) bytes in the file.
+    # finally, add the text into the variable s at the end of the file.
+    def write(s)
+      # store the min allowed bytes in the variable min
+      min = Logger.min_size
+      # store the max allowed bytes in the variable max
+      max = Logger.max_size
+      # get number of bytes of filename and store it the variable n
+      n = File.exists?(self.filename) ? File.size(self.filename) : 0
+      # if number of bytes (n) is higer than max, then truncate the first (max-min) bytes in the file.
+      if n > max
+        # Read the content of the file
+        content = File.read(self.filename)
+        # Calculate the number of bytes to truncate
+        truncate_bytes = n - (max - min)
+        # Truncate the first (max-min) bytes in the file
+        truncated_content = content[truncate_bytes..-1]
+        # Write the truncated content back to the file
+        File.open(self.filename, 'w') { |file| file.write(truncated_content) }
+      end
+      #
+      File.open(self.filename, 'a') { |file| file.write(s) }
+    end
+
+    def log(s, datetime=nil)
+      ltext = super(s, datetime)
+      self.write(ltext)
+      ltext
+    end
+  
+    # 
+    def logs(s, datetime=nil)
+      ltext = super(s, datetime)
+      self.write(ltext)
+      ltext
+    end # def logs
+  
+    # 
+    def logf(s, datetime=nil)      
+      ltext = super(s, datetime)
+      self.write(ltext)
+      ltext
+    end # def logf
+
+    # 
+    def release()
+      BlackStack::LocalLoggerFactory.release(self.filename)
+    end
+
+  end # class LocalLogger
 end # module BlackStack