rt-logman 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0fd4713e9ae89962d5c9d63dce15c9592b66c0e
-  data.tar.gz: bcc046ddbbb50f4563e7ad6f7687a7f923b8014f
+  metadata.gz: cb547bfe89e346a9c9198e1fe5f49c536d8a81e8
+  data.tar.gz: 6fd763746e3360aef85d2296002ecad1fbf28693
 SHA512:
-  metadata.gz: '03663528dfe5ab510667cc91966da0776c0b847ce0ac5936b319d774bf6d57fd0e31c8ed67bc070969ac9e571979b35896cafd100478b2adf5a332bf9c406c9c'
-  data.tar.gz: 295666771e628e232c630d1a8dde906029213f7b0b7895e03ba31a5e2cadf1ee7a42d8e04d831d7b6ea0468d2acee1f45675932c6c58ec3e00b831bd5151545c
+  metadata.gz: c48037c426a5a926734a06cf3a9e0feaf40eb4752ae7a36e4847914f672374f46cdbd5f350cf5c9f09777c0d6e60f0a2def30e52e8edf9b3c7534ec8d00102fa
+  data.tar.gz: 83ab488cf6dc57d35790134b385b9d6d7ff1ca860bc1f9c943863ed158f86e3710ce3e298c2d6b7404216b4df6421dab525d2d38f4a92b4543618cbdd14b02de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rt-logman (0.9.0)
+    rt-logman (0.10.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -154,6 +154,56 @@ create a new Logman instance with the same fields as the previous instance:
 # level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Hello' version='v2'
 ```
 
+With Logman, you can instrument data processing with a logger block. For
+example, if you want to log the steps in a user sign-up progress:
+
+``` ruby
+Logman.process("user-registration", :username => "shiroyasha") do |logger|
+  user = User.create(params)
+  logger.info("User Record Created")
+
+  SigupEmail.send(user)
+  logger.info("Sent signup email")
+
+  team.add(user)
+  logger.info("Added user to a team", :team_id => team)
+end
+```
+
+The above will log the following information:
+
+``` txt
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-started' username='shiroyasha'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='User Record Created' username='shiroyasha'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Sent signup email' username='shiroyasha'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Added user to a team' username='shiroyasha' team_id='312'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-finished' username='shiroyasha'
+```
+
+In case of an exception, the error will be logger and re-thrown:
+
+``` ruby
+Logman.process("user-registration", :username => "shiroyasha") do |logger|
+  user = User.create(params)
+  logger.info("User Record Created")
+
+  SigupEmail.send(user)
+  logger.info("Sent signup email")
+
+  raise "Exception"
+
+  team.add(user)
+  logger.info("Added user to a team", :team_id => team)
+end
+```
+
+``` ruby
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-started' username='shiroyasha'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='User Record Created' username='shiroyasha'
+level='I' time='2017-12-11 09:47:27 +0000' pid='1234' event='Sent signup email' username='shiroyasha'
+level='E' time='2017-12-11 09:47:27 +0000' pid='1234' event='user-registration-failed' username='shiroyasha' type='RuntimeError' message='Exception'
+```
+
 ## Development
 
 After checking out the repo:

data/lib/logman/version.rb

@@ -1,3 +1,3 @@
 class Logman
-  VERSION = "0.9.0".freeze
+  VERSION = "0.10.0".freeze
 end

data/lib/logman.rb

@@ -2,6 +2,7 @@ require "logman/version"
 require "logger"
 
 # :reek:PrimaDonnaMethod { exclude: [clear! ] }
+# :reek:TooManyStatements{ exclude: [process ] }
 class Logman
   SEVERITY_LEVELS = %i(fatal error warn info debug).freeze
 
@@ -10,8 +11,14 @@ class Logman
       @default_logger ||= Logman.new
     end
 
+    def process(name, metadata = {}, &block)
+      default_logger.process(name, metadata, &block)
+    end
+
     SEVERITY_LEVELS.each do |severity|
-      define_method(severity) { |message, metadata| default_logger.public_send(severity, message, metadata) }
+      define_method(severity) do |message, *args|
+        default_logger.public_send(severity, message, args.first || {})
+      end
     end
   end
 
@@ -42,7 +49,23 @@ class Logman
   end
 
   SEVERITY_LEVELS.each do |severity|
-    define_method(severity) { |message, metadata| log(severity, message, metadata) }
+    define_method(severity) do |message, *args|
+      log(severity, message, args.first || {})
+    end
+  end
+
+  def process(name, metadata = {})
+    logger = Logman.new(:logger => self)
+    logger.add(metadata)
+
+    logger.info("#{name}-started")
+
+    yield(logger)
+
+    logger.info("#{name}-finished")
+  rescue StandardError => exception
+    logger.error("#{name}-failed", :type => exception.class.name, :message => exception.message)
+    raise
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rt-logman
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rendered Text
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler