GunnyLog 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d8ed19e0851ad8bef2a9bd8c12d3a97b1cd2a5f
-  data.tar.gz: 55a0da85b35c10fd823f439394ce18f403396fcf
+  metadata.gz: ce05dbfada2cc1e42ff869d414a8a4e671f4b95f
+  data.tar.gz: fa999833bef668ac86de3e7cfbf42455947b034a
 SHA512:
-  metadata.gz: bab38a928d3e7139bc8b513b271889d2144b2f71de40bfce02c28eb5c290c7236989dcd98b40c20c6e176b9750d88f92224837538f7f25a504000180df5b35be
-  data.tar.gz: a5e7e859cea8cf82ad97eaac58a602adb7ae70455142ab739994b6ad4f6c8f181e620a49602955c6479ce1840c2dbc97c8c2a0bc0a6bda5f32b7517e28223c40
+  metadata.gz: cc374fce9a7214cf426a3e93357ccf73ee09129161bed98ce5b781d6640fe50002af7b1693ff954a21b5e29f697f4fc285785100a790911522a39c66457022af
+  data.tar.gz: a72e128408ce5498d3526485e4a4c9d461b4fe8c013648c80ada8895928a3ecd45b2a8905f33fd389d39b5e0363e558007470f86a2bb147147b6ab5612c381cf

data/lib/GunnyLog.rb

@@ -5,37 +5,51 @@ require 'date'
 
 # GunnyLog logs messages to stdout or a file
 class GunnyLog
-    
-    include Singleton
 
-    # set logging on and off
-    # @param [bool] switch
+    # Singleton instance method
+    def self.instance
+      @@instance ||= new
+    end
+
+    # Set logging on and off
+    #
+    # @param switch [bool] switch for on or off
     def set_switch(switch)
         @onoffswitch = switch
     end
 
-    # set location message was logged from
-    # @param [string] name
+    # Set message was logged from location
+    #
+    # @param name [string] location name
     def set_location(name)
         @location = name
     end
 
-    # open the logfile
-    # @param [string] filename
+    # Open the logfile
+    #
+    # @param filename [string] name of the .log file
     def open(filename = 'gunnylog')
       @outfile = File.open(filename  + '.log', 'a+')
       @_is_file_open = true
     end
 
-    # close the logfile
+    # Close the logfile
     def close
       @outfile.close
       @_is_file_open = false
     end
 
-    # write message to file
-    # @param [string] loc - message location, optional
-    # @param [string] msg - message string
+    # Write message to file
+    #
+    # @param msg [string] message string
+    def msg(msg)
+      message(nil,msg)
+    end
+
+    # Write message to file
+    #
+    # @param loc [string] message location, optional
+    # @param msg [string] message string
     def message(loc = nil, msg)
       if @_is_file_open
         write_msg(@outfile, loc, msg)
@@ -44,19 +58,21 @@ class GunnyLog
       end
     end
 
-    # write formatted message - single arg or array of args
-    # @param [string] loc - message location, optional
-    # @param [string] msg - message format string
-    # @param [arg or array of args]
+    # Write formatted message with single arg or array of args
+    #
+    # @param loc [string] message location, optional
+    # @param msg [string] message format string
+    # @param args [arg or array of args]
     def formatted_message(loc = nil, msg, args)
         formatted = sprintf(msg, *args)
         message(loc, formatted)
     end
 
-    # write formatted message - variable number of args
-    # @param [string] loc - message location
-    # @param [string] msg - message format string
-    # @param [variable number of args]
+    # Write formatted message with variable number of args
+    #
+    # @param loc [string] message location
+    # @param msg [string] message format string
+    # @param args [variable number of args]
     def formatted_message_vars(loc, msg, *args)
         formatted = sprintf(msg, *args)
         message(loc, formatted)
@@ -64,33 +80,49 @@ class GunnyLog
 
     private
 
+    include Singleton
+
     # logging off and on flag
     class << self;
       attr_accessor :onoffswitch
     end
-    @onoffswitch = true
 
     # location message was logged from
     class << self;
       attr_accessor :location
     end
-    @location = 'MainMethod'
 
     # is file open flag
     class << self;
       attr_accessor :_is_file_open
     end
-    @_is_file_open = false
 
+    # log file
+    class << self;
+      attr_accessor :outfile
+    end
+
+    # initailize
+    def initialize
+      @onoffswitch = true
+      @location = 'MainMethod'
+      @_is_file_open = false
+      @outfile = STDOUT
+    end
+
+    # write the msg
     def write_msg(output, loc, msg)
         if loc == nil
           loc = @location
+        else
+          @location = loc
         end
         if @onoffswitch
-            output.puts "#{date_str}|#{loc}|#{msg}"
+            output.puts "#{date_str}|#{$0}|#{loc}|#{msg}"
         end
     end
 
+    # get the date time stamp
     def date_str
         d = DateTime.now
         d.strftime('%m/%d/%Y|%I:%M:%S%p')
@@ -98,7 +130,7 @@ class GunnyLog
     
 end
 
-# GunnyLogFile from earlier versions
-class GunnyLogFile < GunnyLog
 
+# @deprecated Use {#GunnyLog} instead
+class GunnyLogFile < GunnyLog
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: GunnyLog
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - GunnyHwy