RubyGems - tlogger - Versions diffs - 0.6.0 → 0.22.0 - Mend

tlogger 0.6.0 → 0.22.0

Files changed (20) hide show

checksums.yaml +4 -4
data/.gitignore +2 -0
data/.travis.yml +6 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +3 -0
data/README.md +91 -9
data/Rakefile +9 -1
data/bin/console +4 -4
data/lib/tlogger.rb +11 -309
data/lib/tlogger/logger_group.rb +105 -0
data/lib/tlogger/tlogger.rb +380 -0
data/lib/tlogger/version.rb +1 -1
data/samples/basic.rb +64 -35
data/samples/group.rb +54 -0
data/tlogger.gemspec +12 -27
metadata +21 -74
data/Gemfile.lock +0 -31
data/LICENSE.txt +0 -21
data/release.job +0 -53
data/samples/basic2.rb +0 -25

@@ -1,3 +1,3 @@
 module Tlogger
-  VERSION = "0.6.0"
+  VERSION = "0.22.0"
 end

data/samples/basic.rb CHANGED

@@ -1,44 +1,73 @@
-#
-# basic use case
-#
-class Cls
-  # to get the with_tag()
-  include Tlogger
-  def initialize
-    @log = Tlogger.new(STDOUT)
-    @log.tag = :cls
-  end
-  def bark
-    @log.debug "wuf wof"
-  end
-  def say
-    with_tag(:say) do
-      @log.debug "inside say"
-      puts "Say hello world!"
-      @log.warn "after hello!"
-    end
-    @log.error "Error here..."
-  end
+require 'tlogger'
+log = Tlogger::Tlogger.new
+log.debug "Without tagging"
+log.info "Without tagging"
+log.warn "Without tagging"
+log.error "Without tagging"
+# default tag for this loging session
+log.tag = "global"
+log.debug { "With default tagging" }
+log.info { "With default tagging" }
+log.warn { "With default tagging" }
+log.error { "With default tagging" }
+# include the file and location where the log message is printed out
+log.include_caller = true
+log.tdebug :mytag, "With per log message tagging"
+log.with_tag :block_tag do |log|
+  log.debug "Inside block"
+  log.info "inside block"
+  log.warn "inside block"
+  log.error "inside block"
+end
+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
+  log.odebug  :debug_once, &-> { "this is one time message" }
+  log.oerror  :error_once,  "One time error"
+  log.oinfo   :info_once,   "One time info"
+  log.owarn   :warn_once,   "One time warning"
+  log.owarn   :warn_once,   "One time warning"  # this line shall be skipped
+  log.oinfo   :info_once,   "One time info"     # this line shall be skipped too
+  # from the output, even this is looped 5 times, only 4 messages shall be printed out
 end
-#if $0 == __FILE__
+log.info "Shall turned off all except tag :whatever"
+log.off_all_except(:whatever,:global)
+log.tdebug :another_global, "I've been turned off"  # this line shall not show in the log output
+log.terror :whatever, "I will survive!"             # this line will show up because it is being exampted
+log.tinfo :global, "Got turned off"                 # this line will show up because it is being exampted
-#Tlogger::TloggerConf.auto_tag_on
-#Tlogger::TloggerConf.disable_all_tags
-#Tlogger::TloggerConf.disable_tag([:cls])
+log.remove_from_exception(:global)
+log.twarn :global, "Since :global is removed from exception, will it print out?"  # this line will not show up because it has removed from examption and shall be off
-c = Cls.new
-c.bark
-c.say
+log.on_all_except(:global)
+log.tdebug :another_global, "Now it is my turn to be here"          # this line will show up because all is on
+log.terror :whatever, "Yeah me too!"                                # this line will show up because all is on
+log.debug "I'm inherited from key :global so I'm also not visible"  # due to on_all_except(:global) this line shall not be printed
+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
-#end
+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/samples/group.rb ADDED

@@ -0,0 +1,54 @@
+require "tlogger"
+include Tlogger
+mlog = LoggerGroup.new
+# create logger goes to STDOUT
+lout = mlog.create_logger(:stdout, STDOUT)
+# create logger using default parameter, to STDOUT too
+# lout = mlog.create_logger(:stdout2)
+# create logger to a log file test.log
+lfile = mlog.create_logger(:file,"test.log", 10, 1024000)
+# create logger to memory buffer
+buf = StringIO.new
+lbuf = mlog.create_logger(:io,buf)
+mlog.with_tag(:block) do |log|
+  # following 4 lines shall all be printed in all given 3 loggers
+  log.debug "inside block"
+  log.error "Wow error!"
+  log.info  "Still inside block"
+  log.warn  "Warning!"
+  # following 2 lines shall only got 1 line printed in all 3 loggers
+  log.odebug :once, "this should print out once!"
+  log.odebug :once, "this should print out once!"
+end
+# following two lines shall be printed on STDOUT only
+lout.tdebug :test, "test output"
+lout.debug "again"
+ioLog = mlog.detach_logger(:io)
+# this line shall not be printed to memory buffer but shall be in other 2
+mlog.debug "Last line"
+ioLog.info "This only inside memory buffer"
+buf.rewind
+dat = buf.read
+puts "**** Content of memory buffer ****"
+dat.each_line do |l|
+  puts l.strip
+end
+puts "**** End of content of memory buffer ****"
+mlog.close
+# since this log already detach, application should close it when finished using it
+ioLog.close

data/tlogger.gemspec CHANGED

@@ -1,31 +1,23 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "tlogger/version"
+require_relative 'lib/tlogger/version'
 Gem::Specification.new do |spec|
   spec.name          = "tlogger"
   spec.version       = Tlogger::VERSION
-  spec.authors       = ["Chris Liaw"]
+  spec.authors       = ["Chris"]
   spec.email         = ["chrisliaw@antrapol.com"]
-  spec.summary       = ""
-  spec.description   = ""
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.summary       = %q{Logger that added contextual information to the log messages}
+  spec.description   = %q{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}
+  spec.homepage      = "https://github.com/chrisliaw/tlogger"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.licenses      = ["MIT"]
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  #if spec.respond_to?(:metadata)
-  #  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-  #  spec.metadata["homepage_uri"] = spec.homepage
-  #  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  #else
-  #  raise "RubyGems 2.0 or newer is required to protect against " \
-  #    "public gem pushes."
-  #end
+  spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -35,11 +27,4 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = '>= 1.8.6'
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
 end

metadata CHANGED

@@ -1,72 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: tlogger
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.22.0
 platform: ruby
 authors:
-- Chris Liaw
-autorequire:
+- Chris
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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: ''
+date: 2020-10-13 00:00:00.000000000 Z
+dependencies: []
+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
 email:
 - chrisliaw@antrapol.com
 executables: []
@@ -74,24 +20,26 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/tlogger.rb
+- lib/tlogger/logger_group.rb
+- lib/tlogger/tlogger.rb
 - lib/tlogger/version.rb
-- release.job
 - samples/basic.rb
-- samples/basic2.rb
+- samples/group.rb
 - tlogger.gemspec
-homepage: ''
+homepage: https://github.com/chrisliaw/tlogger
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/chrisliaw/tlogger
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,16 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.6
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
-signing_key:
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: ''
+summary: Logger that added contextual information to the log messages
 test_files: []

data/Gemfile.lock DELETED

@@ -1,31 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tlogger (0.5.0)
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.0.1)
-    coderay (1.1.2)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    rake (10.5.0)
-PLATFORMS
-  ruby
-DEPENDENCIES
-  bundler (~> 2.0)
-  pry
-  pry-byebug
-  rake (~> 10.0)
-  tlogger!
-BUNDLED WITH
-   2.0.1

data/LICENSE.txt DELETED

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-Copyright (c) 2019 Chris Liaw
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/release.job DELETED

@@ -1,53 +0,0 @@
-job :release do
-  include_job :prompt_version
-  #ver = prompt "Please provide version for this release:", required: true
-  #set :releasing_version, ver
-  include_job :build
-  include_job :check_in
-end
-job :prompt_version do
-  if get(:releasing_version) == nil
-    ver = prompt "Please provide version for this release:", required: true
-    set :releasing_version, ver
-  end
-end
-job :build do
-  dir '/Volumes/Stash/08.Dev/01.Workspaces/incu-2019/tlogger'
-  include_job :prompt_version
-  rubygem do
-    #publish build('alog.gemspec'), ignore_status: true #do |res|
-    build('tlogger.gemspec') do |res|
-      publish(res, ignore_status: true)
-    end
-  end
-end
-job :check_in do
-  dir '/Volumes/Stash/08.Dev/01.Workspaces/incu-2019/tlogger'
-  git do
-    commit
-    tag
-    push 'origin', 'master'
-    push 'git','master'
-  end
-end
-job :reinstall do
-  rubygem do
-    uninstall 'tlogger'
-    install 'tlogger'
-  end
-end