pyer-logger 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4894005ac53da8f7ef99404bb956084a6597b74a
-  data.tar.gz: a1f12c6a90d1f0b40119569ea4e644f0cacf4179
+SHA256:
+  metadata.gz: 1239e84aed003d02e0a53e220105bfa585d010203fdd780e3f7a971a5ca7452d
+  data.tar.gz: 3dbc619afd00da79ebc75f319039d116460ed30893ab3c294de61971a1c662d5
 SHA512:
-  metadata.gz: 1e2d24fc6088ae0e165f7c5161e3f1a503e90134669dfb071974676df6d578079691a67e5ee7bd393aad16828c3245afaaff875c7daf87b89677551add4af111
-  data.tar.gz: ad1bdecdf44243373a05c67c52cddd8eea57060a027bd43770bdf1732ba5104b4071027c86c8d2da4cd82e8e84f4d3182a045f754b9a3213d3e4a64f96d6ef5c
+  metadata.gz: 2c91ef693c7a0c6b33573a4a131fdbfb07c50dcd7621a5eeecf8fc45f9310f87880944ae5722d968d23b82dfd439666bef02d31a291fae5a2bb7d1443cd89e84
+  data.tar.gz: 56bac97b192dcc5f394b993112aae2249b8ef2362f85fdfa6c40dc11061834f296cf5d6676a4fb0d5f1656d4b6cceb54a7bb3c651e53d5afc60c64771e7d1513

data/lib/pyer/logger.rb

@@ -1,59 +1,78 @@
 # 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
+# 1. DEBUG : low-level information for developers
+# 2. INFO  : generic (useful) information about system operation
+# 3. WARN  : a warning
+# 4. ERROR : an error condition
 #
 # 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')
+#      log = Logger.new('logfile.log', self.class)
 #
-# === How to log a message
+# 3. Create a logger which logs messages to a string.
+#      log = Logger.new(STRING, self.class)
 #
-# 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.
+# Notice that self.class argument prints the class name of the caller object.
 #
-# 1. Message in block.
+# == 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
+#
+# Default log.level is DEBUG. That means all messages are emitted.
+#
+# 1. Debug message
+#      log.debug "dev info"
 #
-#      logger.error { "Argument 'foo' not given." }
+# 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." }
 #
-#      logger.error "Argument #{ @foo } mismatch."
+# == How to set severity level ?
 #
-# === How to set severity level
+#      log.level = INFO
 #
-#      logger.level = Logger::INFO
+# == How to close a logger ?
 #
-#      DEBUG < INFO < WARN < ERROR
+#      log.close
 #
-# === How to close a logger
+# == Installation
 #
-#      logger.close
+#     gem install pyer-logger
 #
-# All my tools are in module Pyer
 module Pyer
   require 'stringio'
 
@@ -192,7 +211,10 @@ module Pyer
   end
 end
 
-# Backward-compatible alias
+# == Aliases
+#
+# Aliases are made to make life simpler.
+#
 Logger = Pyer::Logger
 STRING = Pyer::Logger::STRING
 

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pyer-logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Pierre BAZONNARD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 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
@@ -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