tlogger 0.21.1 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 299b85474257a420194ddf5b6d1bf52b825b92fceb7349f37885b81918fa849c
-  data.tar.gz: 78af413f1ff7add4254fff72d46a17dd9dd0a9677f9497beacb369c2ee5844d3
+  metadata.gz: 456f792986f50cb09f12b7bff8e062cb79cb705700e0a8f909f265d5a5f55df2
+  data.tar.gz: 16434a962194549c73ed7cc27b2b5a848b02c687716f31f59551a9b9e4202b4c
 SHA512:
-  metadata.gz: e9d0e1ee9d45643250732173b473e165573d876b796fc064935c98b2ae1fd06922963db7e86039f0e19f1e1ab1e74d01c4a9d617a1701d27cde1a4fc779cde45
-  data.tar.gz: 8c3de4cacdfbe62fda3eca5592d5b1cca118112da1e4561544a3b47ae9dddf8dd9f9aa265881c99232f0b01250ed32f4374c3ce46106305a4b9dd5c122512274
+  metadata.gz: 7541a13f50860790deb9841cc265c25e37982cb1981de92a4d92fd4fee27473e21aac95a589b7b1f53a6d2afa0dbabf78f53dd499620798d4a1f6d61f222492a
+  data.tar.gz: 055e68a34f282a659d8e7699a52f0206a9149f60bb0b0ed8367f14fb466a7c9c35126a129807cf459b55f315c2c488dfaa4c0921a6505292f333b705b571409b

data/.gitignore

@@ -8,3 +8,5 @@
 /tmp/
 
 *.log
+*.gem
+Gemfile.lock

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+require 'devops_helper'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/lib/tlogger/tlogger.rb

@@ -226,11 +226,11 @@ module Tlogger
         if is_genabled?(key) and not tag_disabled?(key.to_sym)
           if block
             out = Proc.new { block.call }
-            args = [ format_message(args[0]) ]
+            args = [ format_message(key) ]
           else
             str = args[1]
             out = Proc.new { str }
-            args = [ format_message(args[0]) ]
+            args = [ format_message(key) ]
           end
 
           mtd = mtd.to_s[1..-1].to_sym
@@ -245,11 +245,11 @@ module Tlogger
 
           if block
             out = Proc.new { block.call }
-            args = [ format_message(args[0]) ]
+            args = [ format_message(key) ]
           else
             str = args[1]
             out = Proc.new { str }
-            args = [ format_message(args[0]) ]
+            args = [ format_message(key) ]
           end
 
           msg = out.call
@@ -262,6 +262,34 @@ module Tlogger
 
         end
 
+      elsif [:ifdebug, :iferror, :ifinfo, :ifwarn].include?(mtd)  
+     
+        cond = args[0]
+        key = args[1]
+
+        if cond.is_a?(Proc)
+          cond = cond.call
+        end
+
+        if is_genabled?(key) and not tag_disabled?(key) and cond
+
+          if block
+            out = Proc.new { block.call }
+            args = [ format_message(key) ]
+          else
+            str = args[2]
+            out = Proc.new { str }
+            args = [ format_message(key) ]
+          end
+
+          msg = out.call
+          if not (msg.nil? or msg.empty?) 
+            mtd = mtd.to_s[2..-1].to_sym
+            @logger.send(mtd, *args, &out)
+          end
+
+        end
+
       elsif @logger.respond_to?(mtd)
         @logger.send(mtd, *args, &block)
       else

data/lib/tlogger/version.rb

@@ -1,3 +1,3 @@
 module Tlogger
-  VERSION = "0.21.1"
+  VERSION = "0.26.0"
 end

data/lib/tlogger.rb

@@ -8,13 +8,59 @@ require_relative "tlogger/logger_group"
 #
 module Tlogger
   class Error < StandardError; end
-
+ 
   # shorten the initializer to Tlogger.new instead of the longer Tlogger::Tlogger.new
   class << self
     def new(*args,&block)
       ::Tlogger::Tlogger.new(*args,&block) 
     end
+
+    # detect if the prompt should be to env or file
+    def init
+      p is_dev?
+      if is_dev?
+        new(STDOUT) 
+      else
+        c = output_channel
+        new(*c[:path])
+      end
+    end
+
+    def set_dev_mode
+      ENV["TLOGGER_MODE"] = "dev"
+    end
+
+    def set_production_mode
+      ENV.delete("TLOGGER_MODE")
+    end
+
+    def is_dev?
+      ENV.keys.include?("TLOGGER_MODE") and ENV["TLOGGER_MODE"].downcase == "dev"
+    end
+
+
+    private
+    def output_channel
+      out = ENV["TLOGGER_OUT"]
+      if not out.nil?
+        case out
+        when "file"
+          path = ENV["TLOGGER_OUTPATH"]
+          if path =~ /,/
+            { mode: :file, path: path.split(",") }
+          else
+            { mode: :file, path: [path] }
+          end
+        else
+          { mode: :file, path: [nil] }
+        end
+      else
+        { mode: :stdio, path: [nil] }
+      end
+    end
   end # class self
 
+
 end
 
+

data/lib/tlogger_helper.rb

@@ -0,0 +1,35 @@
+
+require_relative 'tlogger'
+
+module Tlogger
+  module TloggerHelper
+
+    module TloggerClassMethods
+      def tlogger(tag = nil)
+        if @tlogger.nil?
+          @tlogger = ::Tlogger.init
+          @tlogger.tag = tag if not (tag.nil? and tag.empty?)
+        end
+        @tlogger
+      end
+
+      def default_logger(tag, dev_mode = false)
+        ::Tlogger.set_dev_mode if dev_mode
+        tlogger(tag)  
+      end
+    end
+
+    def self.included(klass)
+      klass.extend(TloggerClassMethods)
+    end
+
+    self.extend(TloggerClassMethods)
+
+    if not respond_to?(:logger)
+      def logger
+        self.class.tlogger
+      end
+    end
+
+  end
+end

data/samples/basic.rb

@@ -32,6 +32,7 @@ log.debug "Outside block. Shall take default tag '#{log.tag}'"
 
 log.debug "About to show log message only show once. This can be useful if it is a warning which only print out per run."
 (0..4).each do |i|
+  # Show message once only
   # one time message tie to key
   # Means if the message is under specific key and already prompted, it will skip
   # Else it will be printed
@@ -60,3 +61,13 @@ log.debug "I'm inherited from key :global so I'm also not visible"  # due to on_
 log.tinfo :global, "Gosh! I've been turned off by default"          # due to on_all_except(:global) this line shall not be printed
 log.twarn :local, "I'm free!"                                       # this line will show up because all is on
 
+x = 2
+# Log only print if the first parameters is true.
+log.ifdebug(x == 2, :ifdebug, "Debug : x == 2!")
+log.iferror(x == 2, :iferror, "Err : x == 2!")
+log.ifinfo(x == 2, :ifinfo, "Info: x == 2!")
+log.ifwarn(x == 2, :ifwarn, "Warn: x == 2!")
+
+# first param also can be a proc
+log.ifdebug Proc.new { x == 2 }, :ifdebug2, "Debug 2 : x == 2!"
+

data/tlogger.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "devops_helper"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tlogger
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.26.0
 platform: ruby
 authors:
 - Chris
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-16 00:00:00.000000000 Z
-dependencies: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devops_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Logger that provides some control over how the log messages are being
   displayed with conditionally enable and disable certain log messages from showing
   based on configurations
@@ -31,6 +45,7 @@ files:
 - lib/tlogger/logger_group.rb
 - lib/tlogger/tlogger.rb
 - lib/tlogger/version.rb
+- lib/tlogger_helper.rb
 - samples/basic.rb
 - samples/group.rb
 - tlogger.gemspec
@@ -39,7 +54,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/chrisliaw/tlogger
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -54,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Logger that added contextual information to the log messages
 test_files: []