pyer-logger 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7439de8b230e777556ad8338f1f20eea207fcae
-  data.tar.gz: 26454618ccb4283a7d315cb08fa8d7f072e46bb7
+SHA256:
+  metadata.gz: 37b2bd3c55935f4e00ad24afb3eefd3cefba458ab76124aec5d48c8d94864f21
+  data.tar.gz: 0dfa99dc327452c4cb2842df8c9bfa2860e331b60d07fcb96e42cbb483aac9be
 SHA512:
-  metadata.gz: dd2e3a78cb157f407df769b086f3b473301653766847272385986d6bc7847ec3f37c3a4d653b39b9a362926df0a481bc891f247da37f143055d5d92950bc76be
-  data.tar.gz: d64485503494cebc39af119faeb6cba7db1dad0ea343218c24825953f8cdec7de40a28c9498d36f9f8816c9f7cdd83011ed03993c471bdd85acd206699ee7f67
+  metadata.gz: 59f2837376f51a162cd49801ab6a2a02db831b663c0017b64f5d8ea3d5c7599c3b01caa99f2393213f5791345f40496c6014127f768d357d47314e8b1581c09d
+  data.tar.gz: 6005918677f4113ea853ae2fc289b08f4260ad62a11540b64616f6c765769bb8ce835567d836f8bfed84282670b8aedaca6298f9f54d9fcbfc0d5bf01947a547

data/lib/pyer/logger.rb

@@ -2,77 +2,80 @@
 #
 # This Logger class provides a simple logging utility for Ruby applications.
 # Log messages are sent to stdout, stderr, a file or a string by a Logger object.
-# 
+#
 # The messages will have varying levels reflecting their varying importance.
 # The levels, and their meanings, are:
 # 1. DEBUG : low-level information for developers
 # 2. INFO  : generic (useful) information about system operation
 # 3. WARN  : a warning
 # 4. ERROR : an error condition
-# 
+# 5. NONE  : no log
+#
 # So each message has a level, and the Logger itself has a level, which acts
 # as a filter, so you can control the amount of information emitted from the
 # logger without having to remove actual messages.
-# 
+#
 # == How to create a logger ?
-# 
-# 1. Create a logger which logs messages to STDERR/STDOUT.
-#      log = Logger.new(STDOUT, self.class)
-#      log = Logger.new(STDERR, self.class)
-# 
-# 2. Create a logger for the file which has the specified name.
-#      log = Logger.new('logfile.log', self.class)
-# 
-# 3. Create a logger which logs messages to a string.
-#      log = Logger.new(STRING, self.class)
-# 
-# Notice that self.class argument prints the class name of the caller object.
-# 
+#
+# 1. Create a default logger which logs messages to STDOUT
+#      log = Logger.new
+#
+# 2. Create a logger which logs messages to STDOUT or STDERR.
+#      log = Logger.new(STDOUT)
+#      log = Logger.new(STDERR)
+#
+# 3. Create a logger for the file which has the specified name.
+#      log = Logger.new('logfile.log')
+#
+# 4. Create a logger which logs messages to a string.
+#      log = Logger.new(STRING)
+#
 # == How to log a message ?
-# 
-# Notice the different methods being used to log messages of various levels.
 #
 # Messages lower than log.level are not sent to output.
+# Ranking: DEBUG < INFO < WARN < ERROR < NONE
+# Default Logger.level is DEBUG. That means all messages are emitted.
+# Each logger level is initialized with Logger.level and can set a different level.
 #
-# Ranking: DEBUG < INFO < WARN < ERROR
-#
-# Default log.level is DEBUG. That means all messages are emitted.
-# 
 # 1. Debug message
 #      log.debug "dev info"
-# 
+#
 # 2. Information
 #      log.info  "some informations"
-# 
+#
 # 3. Warning message
 #      log.warn  "a warning message"
-# 
+#
 # 4. Error message
 #      log.error "error is #{ @code }"
-# 
+#
 # Messages are provided in a string or in a block, or both.
-# 
+#
 # 1. Message in block.
 #      log.error { "Argument 'foo' not given." }
-# 
+#
 # 2. Message as a string.
 #      log.error "Argument #{ @foo } mismatch."
-# 
+#
 # 3. Both arguments
-#      log.error("Argument ") { "#{ @foo } mismatch." } 
-# 
+#      log.error("Argument ") { "#{ @foo } mismatch." }
+#
 # == How to set severity level ?
 #
 #      log.level = INFO
-# 
+#
+# == How to set default severity level ?
+#
+#      Logger.level = NONE
+#
 # == How to close a logger ?
-# 
+#
 #      log.close
-# 
+#
 # == Installation
-# 
-#     gem install pyer-options
-# 
+#
+#     gem install pyer-logger
+#
 module Pyer
   require 'stringio'
 
@@ -84,59 +87,59 @@ module Pyer
       INFO  = 1
       WARN  = 2
       ERROR = 3
+      NONE  = 4
       # Severity label for logging. (max 5 char)
-      SEVERITY_LABELS = ['DEBUG', 'INFO ', 'WARN ', 'ERROR']
-      COLOURED_LABELS = ["\033[44mDEBUG\033[m", "\033[42mINFO \033[m", "\033[43mWARN \033[m", "\033[41mERROR\033[m"]
+      SEVERITY_LABELS = ['DEBUG', 'INFO ', 'WARN ', 'ERROR', 'NONE']
+      COLOURED_LABELS = ["\033[44mDEBUG\033[m", "\033[42mINFO \033[m", "\033[43mWARN \033[m", "\033[41mERROR\033[m", ""]
     end
     include Severity
 
     STRING = -1
 
-    # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
-    attr_accessor :level
-
-    # Returns +true+ if the current severity level allows the printing of the message
+    @@default_level = DEBUG
 
-    def debug?
-      @level <= DEBUG
+    def self.level=(level)
+      @@default_level = level
     end
 
-    def info?
-      @level <= INFO
+    def self.level
+      @@default_level
     end
 
-    def warn?
-      @level <= WARN
-    end
+    # Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
+    attr_accessor :level
 
-    def error?
-      @level <= ERROR
-    end
+    # Prefix can be the class name
+    attr_accessor :prefix
 
     # Create an instance.
     # outputs log messages on STDOUT, STDERR, a file or a StringIO
     #
-    def initialize(logdev = nil, klass = nil)
-      @level = DEBUG
+    def initialize(logdev = STDOUT)
+      @level = @@default_level
+      @prefix = ""
       @logdev = $stdout
       @severity_label = COLOURED_LABELS
-      @klass_name = ''
-      @klass_name = klass.name unless klass.nil?
-      return if logdev.nil?
-      if logdev == STRING
-        # no log device implies that messages are stored in a string
-        @logdev = StringIO.new
-        @severity_label = SEVERITY_LABELS
+      if logdev == STDOUT
+        @logdev = $stdout
       else
-        if logdev == STDOUT
-          @logdev = $stdout
+        if logdev == STDERR
+          @logdev = $stderr
         else
-          if logdev == STDERR
-            @logdev = $stderr
-          else
-            # the default log device is a file name
-            @logdev = File.new(logdev.to_s, 'a')
+          if logdev == STRING
+            # no log device implies that messages are stored in a string
+            @logdev = StringIO.new
             @severity_label = SEVERITY_LABELS
+          else
+            if logdev.is_a? String
+              # the log device is a file name
+              @logdev = File.new(logdev.to_s, 'a')
+              @severity_label = SEVERITY_LABELS
+            else
+              # the default is no log
+              @level = NONE
+              @logdev = $stderr
+            end
           end
         end
       end
@@ -179,15 +182,15 @@ module Pyer
       return if @logdev.nil? || severity < @level
       message = '' if message.nil?
       message += block.call if block_given?
-      @logdev.write(Formatter.new.string(@klass_name, @severity_label[severity], message))
+      @logdev.write(Formatter.new.string(@prefix, @severity_label[severity], message))
     end
   end
 
   # Formatter class
   class Formatter
     FORMAT = "%s [%5d] %12s %s  %s\n"
-    def string(klass_name, label, message = nil)
-      format(FORMAT, format_datetime(Time.now), $$, klass_name, label, format_message(message))
+    def string(prefix, label, message = nil)
+      format(FORMAT, format_datetime(Time.now), $$, prefix, label, format_message(message))
     end
 
     private
@@ -211,7 +214,10 @@ module Pyer
   end
 end
 
-# Backward-compatible alias
+# == Aliases
+#
+# Aliases are made to make life simpler.
+#
 Logger = Pyer::Logger
 STRING = Pyer::Logger::STRING
 
@@ -219,3 +225,4 @@ DEBUG = Pyer::Logger::DEBUG
 INFO  = Pyer::Logger::INFO
 WARN  = Pyer::Logger::WARN
 ERROR = Pyer::Logger::ERROR
+NONE  = Pyer::Logger::NONE

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pyer-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Pierre BAZONNARD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/pyer/logger.rb
-homepage: https://github.com/pyer/logger
+homepage: https://github.com/pyer/pyer-logger
 licenses:
 - MIT
 metadata: {}
@@ -65,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Logger