pyer-logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4894005ac53da8f7ef99404bb956084a6597b74a
-  data.tar.gz: a1f12c6a90d1f0b40119569ea4e644f0cacf4179
+  metadata.gz: c1fb8264eb6b552bd6372448e9a4892081592355
+  data.tar.gz: 30cbb717001f157d12c927f06c9df5417c26f0b1
 SHA512:
-  metadata.gz: 1e2d24fc6088ae0e165f7c5161e3f1a503e90134669dfb071974676df6d578079691a67e5ee7bd393aad16828c3245afaaff875c7daf87b89677551add4af111
-  data.tar.gz: ad1bdecdf44243373a05c67c52cddd8eea57060a027bd43770bdf1732ba5104b4071027c86c8d2da4cd82e8e84f4d3182a045f754b9a3213d3e4a64f96d6ef5c
+  metadata.gz: a795511e7737515fcf133e42981f5da3728e05c77ea32b40987a90516d2c5540cd75bb2be3c5a1756f3ec74c66ece4bf127b7f5d461337adb133d714b81ebf7c
+  data.tar.gz: bfc035a8d4e80dfc68ca9dab9291c32c3c4bc755365448f57cc37bbb09decfdc9cdcc89665e176cc8e34592c2bc1675c040101d7df936eec2722fa85ec2abfd0

data/lib/pyer/logger.rb

@@ -1,59 +1,82 @@
 # encoding: UTF-8
 #
-# == Description
-#
-# The Logger class provides a simple logging utility.
-#
-# You create a Logger object (output to a file, STDOUT or STDERR).
-# The messages will have varying levels (+info+, +error+, etc),
-# reflecting their varying importance.
-#
+# 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:
-#   +ERROR+:: an error condition
-#   +WARN +:: a warning
-#   +INFO +:: generic (useful) information about system operation
-#   +DEBUG+:: low-level information for developers
-#
+# * ERROR : an error condition
+# * WARN  : a warning
+# * INFO  : generic (useful) information about system operation
+# * DEBUG : low-level information for developers
+# 
 # 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.
-#
-# == HOWTOs
-#
-# === How to create a logger
-#
+# 
+# How to create a logger ?
+# ------------------------
+# 
 # 1. Create a logger which logs messages to STDERR/STDOUT.
-#      logger = Logger.new(STDOUT)
-#      logger = Logger.new(STDERR)
-#
+#      log = Logger.new(STDOUT, self.class)
+#      log = Logger.new(STDERR, self.class)
+# 
 # 2. Create a logger for the file which has the specified name.
-#      logger = Logger.new('logfile.log')
-#
-# === How to log a message
-#
-# Notice the different methods (+fatal+, +error+, +warn+, +info+, +debug+)
-# being used to log messages of various levels.
-# Messages lower than logger.level are not emitted.
-#
+#      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.
+# 
+# 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.
+# 
+# Default log.level is DEBUG. That means all messages are emitted.
+# 
+#      DEBUG < INFO < WARN < ERROR
+# 
+# 1. log.error "error is #{ @code }"
+# 
+# 2. log.warn  "a warning message"
+# 
+# 3. log.info  "some informations"
+# 
+# 4. log.debug "dev info"
+# 
+# Messages are provided in a string or in a block, or both.
+# 
 # 1. Message in block.
-#
-#      logger.error { "Argument 'foo' not given." }
-#
+# 
+#      log.error { "Argument 'foo' not given." }
+# 
 # 2. Message as a string.
-#
-#      logger.error "Argument #{ @foo } mismatch."
-#
-# === How to set severity level
-#
-#      logger.level = Logger::INFO
-#
-#      DEBUG < INFO < WARN < ERROR
-#
-# === How to close a logger
-#
-#      logger.close
-#
-# All my tools are in module Pyer
+# 
+#      log.error "Argument #{ @foo } mismatch."
+# 
+# 3. Both arguments
+# 
+#      log.error("Argument ") { "#{ @foo } mismatch." } 
+# 
+# How to set severity level ?
+# ---------------------------
+# 
+#      log.level = INFO
+# 
+# How to close a logger ?
+# -----------------------
+# 
+#      log.close
+# 
+# 
+# Installation
+# ------------
+# 
+#     gem install pyer-options
+# 
 module Pyer
   require 'stringio'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pyer-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Pierre BAZONNARD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake