spawning-logger 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5780ad3f11ff125fb15075028a3f7ad487040610
-  data.tar.gz: 20087f952ef516872142d8922393fa46cd1f32ca
+  metadata.gz: 5bb688e3f25c13c0b26d0e5c960d03fa77b57910
+  data.tar.gz: 833177faf0509500ffb4d14a9e0badb143b7613d
 SHA512:
-  metadata.gz: 8781d2df8c8a947b376171b192c0dfd7a9f2da3b566479c30a7938a008f50ce55675df4dee379ed512cc70cd44090851a154c13a3ed850765756036be1d855a1
-  data.tar.gz: 3ddd6817ae776b5e46dbcd796df8ebee939eb21e3255c39770bd2e08982324ff7aae030db9066a65de842065d46046106b409edc9832072b488bfa2c17f33a79
+  metadata.gz: b2de04e2356e15c594f744f3013f8de70511a25042fe685a63bb085e29c4e6cb5e8108ec10497a2fb5eb394473c38208bafd003e5c8b189a4801ce40974e600f
+  data.tar.gz: 362e925786791024ab90f72ffe52ecb7de04c013a88362c8c4761c3927dc5f3917e3584f35282f02e30b75fdec34ee723d19859040a13892f527767227d7f7cb

data/README.md

@@ -10,10 +10,20 @@ This logger can spawn sub-loggers with different files, each of those file's nam
 
 Also supports a preset logfile subdirectory in case you create many subloggers (for example you might be interested in splitting development, production, test logs into subdirectories).
 
-Only the constructor is modified and the spawning factory method added, everything else is delegated to the ruby stdlib ::Logger class.
-
+Only the constructor is modified and the spawning factory method added, everything else is delegated to the ruby stdlib ::Logger class.  
 ## Examples:
 
+### quick-n-dirty:
+```ruby
+require 'spawning_logger'
+logger = SpawningLogger.new('server.log')
+
+logger.info('special test message')
+logger.spawn('special').info('special test message')
+
+# => writes message into ./server.log and ./server_special.log
+```
+
 ### 1) usage same as ::Logger
 
 ```ruby
@@ -59,3 +69,26 @@ child_logger = logger.spawn('1')
 # => creates ./log/production/server.log
 # => creates ./log/production/server_worker_1.log
 ```
+
+
+### 5) log into main logfile and into a child logger's logfile
+
+```ruby
+logger = SpawningLogger.new('log/server.log')
+logger.send_self_and_spawn(:error, "worker_1", "server shutdown")
+
+# => "server shutdown" will show up in server.log and in server_worker_1.log
+```
+
+
+### 6) logger spawning recursion
+
+```ruby
+logger = SpawningLogger.new('log/server.log')
+child = logger.spawn('child1')
+sub_child = child.spawn('child2')
+
+# => creates ./log/production/server.log
+# => creates ./log/production/server_child1.log
+# => creates ./log/production/server_child1_child2.log
+```

data/lib/spawning_logger.rb

@@ -53,6 +53,29 @@
 # # => creates ./log/production/server.log
 # # => creates ./log/production/server_worker_1.log
 # ```
+#
+#
+# ### 5) log into main logfile and into a child logger's logfile
+#
+# ```ruby
+# logger = SpawningLogger.new('log/server.log')
+# logger.send_self_and_spawn(:error, "worker_1", "server shutdown")
+#
+# # => "server shutdown" will show up in server.log and in server_worker_1.log
+# ```
+#
+#
+# ### 6) logger spawning recursion
+#
+# ```ruby
+# logger = SpawningLogger.new('log/server.log')
+# child = logger.spawn('child1')
+# sub_child = child.spawn('child2')
+#
+# # => creates ./log/production/server.log
+# # => creates ./log/production/server_child1.log
+# # => creates ./log/production/server_child1_child2.log
+# ```
 
 require 'logger'
 
@@ -101,6 +124,14 @@ class SpawningLogger < ::Logger
     @child_loggers[child_name]
   end
 
+  # logs into the main logfile and also logs into a spawned logfile.
+  # @param method The method name to call, like :error, :info, :debug, ...
+  # @param message the message to send to both loggers
+  def send_self_and_spawn(child_name, method, message)
+    self.send(method, message)
+    self.spawn(child_name).send(method, message)
+  end
+
   protected
 
     # creates a logger for child_name. uses child_name and
@@ -122,7 +153,7 @@ class SpawningLogger < ::Logger
       file_name = file_basename + File.extname(@file_name)
 
       file_path = File.join(@log_dir, file_name)
-      ::Logger.new(file_path)
+      self.class.new(file_path)
     end
 
 end

data/lib/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class SpawningLogger < ::Logger
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/spawning_logger_test.rb

@@ -52,6 +52,25 @@ class SpawningLoggerTest < MiniTest::Test
     end
   end
 
+  def test_send_self_and_spawn_calls_both
+    logger = SpawningLogger.new(@logfile_path)
+    logger.send_self_and_spawn("childid", :error, "test_self_and_spawn_calls_both")
+
+    # make sure log message shows up in main logfile and in spawned logfile
+    [@logfile_path, File.join(@log_dir, 'test_file_childid.log')].each do |path|
+      result = File.read(path)
+      assert_match(/test_self_and_spawn_calls_both/, result)
+    end
+  end
+
+  def test_child_loggers_can_spawn_their_own_child_loggers
+    child = SpawningLogger.new(@logfile_path).spawn('child1')
+    sub_child = child.spawn('child2')
+
+    assert_kind_of(::Logger, sub_child)
+    assert File.exist?(File.join(@log_dir, 'test_file_child1_child2.log'))
+  end
+
   def test_creates_child_logger_only_once
     skip "NYI"
     # TODO

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spawning-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Markus Seeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake