alog 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb68bda881bc65ea41f76f45d895064fd657767ec5864aa0e480e6898b5e2de9
-  data.tar.gz: f0c253638ba29c6c9bf2cb9a907a44ab67d05457a4d6f92d957bd1fbaeb1d1ce
+  metadata.gz: 43c7de3f9d98a68c65cabf1753dc625cc6c22ff67f949c597a59510e251c0535
+  data.tar.gz: 6ddad7d190c8b4af445bc0957673e9439b991cf62ea120b712c2f425a1b51eae
 SHA512:
-  metadata.gz: 20819cf66b6adb5445b46daf7a41cc8fa6df89121ceb0e0af48580dc5599ec545f7cd44babd3878750d37118ad1d02bd21a6d555aece3fd7d7de0ac2a19ae5f7
-  data.tar.gz: 28e749887907824ee69b429028fb523da81ace76f6f17f54ef1281fa3cbd38b566e63c9756371b3898d79f668cdf086668a94b7918a6d40874c8f6496fbf5b73
+  metadata.gz: f2d61ba517582eb874c8a79348f090b44fdc2cc3a729bc96879633b80f672a97fb27d4910b7c677bfcd9757f39b2fa937f114bc80c9c21c386bf2b281892bf42
+  data.tar.gz: 30d8ca5326ab13300f4c73b348fdf1a74e00e8ed00ff805fb82c2cc465117026002a4c9a54106dcb4109c6ac3552fa24ea44ebf9e03e5cbbca3bf95ca96edd7a

data/README.md

@@ -50,6 +50,8 @@ class MyApp
   # Also multiple loggers can be configured by creating multiple keys
   LogFacts[:app_file] = ['app.log',10, 1024000]
   ...
+  # Or use the following method to add the log fact, which will check th existing key before adding
+  add_log_fact(:sys_file, ['sys.log', 10, 1024000])
   
   # STEP 2: Define which keys to activate
   # Any block/log output tagged by the key included in this array shall be printed
@@ -107,16 +109,23 @@ class MyApp
   def my_method2(p2)
     # Method 3 : Create the AOlogger object
     # AOlogger is meant to be proxy for standard Logger, with the tagging and multiple log engines included
-    # The initialize parameter is an array containing key to the LogFacts above...
+    # The initialize parameter is an hash containing keys to configure the tagging and multi logging
+    #
     # In the following case, the AOlogger shall only configured to :stdout configuration (refers above) 
-    # and all logging shall be tagged with key :feature_m
-    @log = AOlogger.new(:feature_m, [:stdout])
+    # and all logging shall be tagged with key :feature_m and active_tag is :global and :feature_m
+    # UNFORTUNATELY THIS WILL BREAK RELEASE VERSION < v0.6
+    @log = AOlogger.new({ key: :feature_m, logEng: [:stdout], active_tag: [:global, :feature_m] })
     ...
     ...
     # This behave like standard logging engine
     @log.debug "Code reached here..."
     @log.error "Oppss... We did it again!"
     ...
+    @log.deactivate_tag(:global)   # disable :global tag from this point onwards
+    ...
+    ...
+    @log.activate_tag(:global)      # enable :global tag from this point onwards
+    ...
     ...
     # this API is more explicit and replace all global values
     @log.log("this only shown if tag :feature_x is activated", :debug, :feature_x, [:app_file])

data/lib/alog/version.rb

@@ -1,3 +1,3 @@
 module Alog
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 end

data/lib/alog.rb

@@ -16,6 +16,14 @@ module Alog
   # LogFacts entry given by application
   GLog = {}
 
+  def add_log_fact(key, conf)
+    # add new log fact to global if not defined
+    if LogFacts.include?(key)
+    else
+      LogFacts[key] = conf
+    end
+  end
+
   # 
   # class Alogger
   # Inherited from standard library Logger
@@ -41,14 +49,36 @@ module Alog
   #
   class AOlogger
     attr_reader :logEng
-    def initialize(key = :global, logEng = [])
-      @myMethods = [:debug, :error, :warn, :warning]
-      @defKey = key
-      @logEng = logEng || []
+    # Major change on v1.0
+    #def initialize(key = :global, logEng = [], active_tag = LogTag)
+    def initialize(params = { key: :global, logEng: [], active_tag: LogTag } )
+      @myMethods = [:debug, :error, :warn, :warning, :info]
+      @defKey = params[:key]
+      @logEng = params[:logEng] || []
+      @activeTag = params[:active_tag] || []
+    end
+
+    def log(msg, ltype = :debug, key = :global, logEng = [], active_tag = [])
+      CondLog.call(msg, { key: (key == :global ? key : @defKey), type: ltype, logEng: (logEng == [] ? @logEng : logEng), active_tag: (active_tag == [] ? @active_tag : active_tag) })
+    end
+
+    def activate_tag(tag, &block)
+      @activeTag << tag
+      block.call if block
+      @activeTag.delete(tag)
+    end
+
+    def deactivate_tag(tag)
+      @activeTag.delete(tag)
     end
 
-    def log(msg, ltype = :debug, key = :global, logEng = [])
-      CondLog.call(msg, { key: key || @defKey, type: ltype, logEng: logEng || @logEng })
+    def ext_error(ex)
+      if ex.is_a?(Exception)
+        error(ex.message)
+        error(ex.backtrace.join("\n"))
+      else
+        error(ex)
+      end
     end
 
     def method_missing(mtd, *args, &block)
@@ -57,6 +87,7 @@ module Alog
         pa = args[1]
         params[:key] = @defKey
         params[:logEng] = @logEng
+        params[:active_tag] = @activeTag
         # TODO cases here may not be extensive to 
         # the original Logger supported.
         case mtd
@@ -69,6 +100,9 @@ module Alog
         when :warn, :warning
           params[:type] = :warn
           CondLog.call(args[0], params, &block)
+        when :info
+          params[:type] = :info
+          CondLog.call(args[0], params, &block)
         end
         
       else
@@ -129,7 +163,9 @@ module Alog
   CondLog = Proc.new do |msg, params = {}, &block|
     key = params[:key] || :global
     type = params[:type] || :debug
-    if defined?(:LogTag) and LogTag.is_a?(Array) and (LogTag.include?(key) or LogTag.include?(:all)) or type == :error
+    activeTag = params[:active_tag] || LogTag
+    #if defined?(:LogTag) and LogTag.is_a?(Array) and (LogTag.include?(key) or LogTag.include?(:all)) or type == :error
+    if (activeTag.include?(key) or activeTag.include?(:all)) or type == :error
       logEng = params[:logEng]
       if logEng == nil or (logEng != nil and logEng.empty?)
         logEng = (LogFacts.length > 0 ? [LogFacts.keys[0]] : [:default])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alog
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Liaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler