multiple_devices_logger 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1ab6f46b22a880122cfcf4c6b84ce37c4fb229b
-  data.tar.gz: c69bcdc6a13537e8267e98435d80d4fc48f3be97
+  metadata.gz: b6446bb60c3aa2bd4d77ede3192dbcea1e7ccf1b
+  data.tar.gz: fdaabdb5898c18815d5c63bd2ae5af243a0bf30e
 SHA512:
-  metadata.gz: 9938b033da846d237f8ab0746e84092e1024198026a3afd020661403eafc49a5e6ab0449a588078577f9658fcaa0784492296c0eb15d10fe17ef29e647321b72
-  data.tar.gz: c100f7447b874b85245ff97b3fed4d4c770c5977bfd1f242455d32123904e60052595dd147ffe0c9742e5f918ccf6db17f15892770f66cb09c007ce8002e7193
+  metadata.gz: 9889055f04b023e94470a1b6ba0358a6247bcd909e6b9534914c958e357fb50316ab0dd7119ba139d62b1fe9bf0bbfebc372e624809cf2e03f01dcdcbefa4af5
+  data.tar.gz: a6ecb9eebccd038791def48cfd5b045ac970adbd4ae9be86aae332e73ca0e7dd2d1780ff867d2870c439e40372c026bc9244d89ec5398520b37ac734fbc2c83d

data/README.mdown

@@ -68,6 +68,26 @@ Just use `#clear_devices` to clear all registered devices:
 logger.clear_devices
 ```
 
+### Custom formatter for each severity
+
+`MultipleDevicesLogger` allows you to configure a formatter for each
+severity via `#set_formatter` method, here is some examples:
+
+```ruby
+# Specify formatter as a block
+logger.set_formatter(:debug) { |severity, time, progname, message| "[#{severity}] #{message}" }
+
+# Formatter can also be specified as first argument
+my_formatter = -> { |severity, time, progname, message| "#{progname} -> #{message} @ #{time}" }
+logger.set_formatter(my_formatter, Logger::ERROR)
+
+# Operators can also be used
+logger.set_formatter('>= warn') { |severity, time, progname, message| "[#{severity}] #{message}" }
+
+# Like #add_device, many severities can be specified
+logger.set_formatter(:debug, :info) { |severity, time, progname, message| "[#{severity}] #{message}" }
+```
+
 ## Executing test suite
 
 This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/multiple_devices_logger.rb

@@ -18,6 +18,7 @@ class MultipleDevicesLogger < Logger
   def initialize
     super(nil)
     clear_devices
+    clear_formatters
   end
 
   def add(severity, message = nil, progname = nil)
@@ -32,7 +33,7 @@ class MultipleDevicesLogger < Logger
         progname = self.progname
       end
     end
-    text = format_message(format_severity(severity), Time.now, progname, message)
+    text = formatter_for(severity).call(format_severity(severity), Time.now, progname, message)
     devices_for(severity).each do |device|
       device.write(text)
     end
@@ -60,6 +61,10 @@ class MultipleDevicesLogger < Logger
     @devices = {}
   end
 
+  def clear_formatters
+    @formatters = {}
+  end
+
   def default_device=(value)
     @default_device = value.is_a?(LogDevice) ? value : LogDevice.new(value)
   end
@@ -68,12 +73,35 @@ class MultipleDevicesLogger < Logger
     @devices[parse_severity(severity)] || [default_device].compact || []
   end
 
+  def formatter_for(severity)
+    @formatters[parse_severity(severity)] || formatter || @default_formatter
+  end
+
   def reopen(log = nil)
     raise NotImplementedError.new("#{self.class}#reopen")
   end
 
+  def set_formatter(*severities)
+    formatter = block_given? ? Proc.new { |*args| yield(*args) } : severities.shift
+    raise ArgumentError.new("Formatter must be specified via first parameter or a block, #{formatter.inspect} given") unless formatter.respond_to?(:call)
+    severities = [severities].flatten
+    if severities.empty?
+      keys = SEVERITIES.values
+    else
+      keys = severities.map { |severity| parse_severities_with_operator(severity) }.flatten.uniq
+    end
+    keys.each do |key|
+      @formatters[key] = formatter
+    end
+    self
+  end
+
   private
 
+  def format_message(severity, datetime, progname, msg)
+    raise NotImplementedError.new("#{self.class}#format_message")
+  end
+
   def parse_severity(value)
     int_value = value.is_a?(Fixnum) ? value : (Integer(value.to_s) rescue nil)
     return int_value if SEVERITIES.values.include?(int_value)

data/spec/multiple_devices_logger_spec.rb

@@ -73,12 +73,29 @@ describe MultipleDevicesLogger do
       logger.add(Logger::WARN, nil, 'BAM!')
     end
 
-    it 'a formatter could be given' do
+    it 'use formatter set via #set_formatter method' do
+      logger.set_formatter('> debug') { |severity, time, progname, message| "Hello #{message}" }
+      expect(STDERR).to receive(:write).with('Hello John')
+      logger.add(Logger::WARN, 'John')
+    end
+
+    it 'use default formatter if not set' do
       logger.formatter = -> (severity, time, progname, message) { "Hello #{progname}: #{message}"  }
       expect(STDERR).to receive(:write).with('Hello World: cool')
       logger.add(Logger::WARN, 'cool', 'World')
     end
 
+    it 'use default formatter if formatter set via #set_formatter does not match severity' do
+      logger.add_device(STDERR, 'debug')
+      logger.set_formatter(:debug) { |severity, time, progname, message| "Hello #{message}" }
+
+      expect(STDERR).to receive(:write).with(/WARN -- : John/)
+      logger.add(Logger::WARN, 'John')
+
+      expect(STDERR).to receive(:write).with('Hello John')
+      logger.add(Logger::DEBUG, 'John')
+    end
+
   end
 
   describe '#add_device' do
@@ -310,6 +327,19 @@ describe MultipleDevicesLogger do
 
   end
 
+  describe '#clear_formatters' do
+
+    it 'removes registerd formatters' do
+      default_formatter = logger.formatter_for(:info)
+      formatter = -> { 'hello' }
+      logger.set_formatter(formatter, :info)
+      expect {
+        logger.clear_formatters
+      }.to change { logger.formatter_for(:info) }.from(formatter).to(default_formatter)
+    end
+
+  end
+
   describe '#default_device' do
 
     it 'is nil by default' do
@@ -371,6 +401,40 @@ describe MultipleDevicesLogger do
 
   end
 
+  describe '#formatter_for' do
+
+    it 'returns a default formatter by default' do
+      expect(logger.formatter_for(:debug)).to be_a(Logger::Formatter)
+    end
+
+    it 'returns formatter set via #formatter= instead' do
+      formatter = -> {}
+      logger.formatter = formatter
+      expect(logger.formatter_for(:info)).to be(formatter)
+    end
+
+    it 'returns formatter set via #set_formatter method' do
+      formatter = -> {}
+      logger.set_formatter(formatter, :debug)
+      expect(logger.formatter_for(:debug)).to be(formatter)
+    end
+
+    it 'priority is #set_formatter -> #formatter' do
+      logger.formatter = -> { 'default' }
+      logger.set_formatter(:info) { 'info formatter' }
+      expect(logger.formatter_for(:debug).call).to eq('default')
+      expect(logger.formatter_for(:info).call).to eq('info formatter')
+      expect(logger.formatter_for(:warn).call).to eq('default')
+    end
+
+    it 'raise an error if severity is invalid' do
+      expect {
+        logger.formatter_for(:bim)
+      }.to raise_error(ArgumentError, "Invalid log severity: :bim")
+    end
+
+  end
+
   describe '#initialize' do
 
     it 'accepts no argument' do
@@ -419,6 +483,73 @@ describe MultipleDevicesLogger do
 
   end
 
+  describe '#set_formatter' do
+
+    it 'sets formatter for devices of given levels' do
+      logger.add_device(STDERR, '> warn')
+      logger.add_device(STDOUT, 'debug')
+      default_formatter = -> { 'world' }
+      formatter = -> { 'hello' }
+      logger.formatter = default_formatter
+
+      expect {
+        logger.set_formatter(formatter, '> info')
+      }.to change { logger.formatter_for('error') }.from(default_formatter).to(formatter)
+
+      expect(logger.formatter_for('debug')).to be(default_formatter)
+    end
+
+    it 'use given block if formatter is not specified' do
+      expect {
+        logger.set_formatter('> debug') { |severity, time, progname, message| "Hello #{message}" }
+      }.to change { logger.formatter_for('info').call('WARN', Time.now, nil, 'John') }.to('Hello John')
+    end
+
+    it 'raise an error if no formatter or block is given' do
+      expect {
+        logger.set_formatter('> debug')
+      }.to raise_error(ArgumentError, 'Formatter must be specified via first parameter or a block, "> debug" given')
+    end
+
+    it 'can be set for all devices' do
+      formatter = -> { 'hello' }
+      logger.add_device(STDERR)
+      logger.set_formatter(formatter, '> debug')
+      expect(logger.formatter_for('info')).to be(formatter)
+      expect(logger.formatter_for('error')).to be(formatter)
+    end
+
+    it 'raise an error if not a proc' do
+      expect {
+        logger.set_formatter(:foo, '> debug')
+      }.to raise_error(ArgumentError, 'Formatter must be specified via first parameter or a block, :foo given')
+    end
+
+    it 'raise an error if no parameter is given' do
+      expect {
+        logger.set_formatter
+      }.to raise_error(ArgumentError, 'Formatter must be specified via first parameter or a block, nil given')
+    end
+
+    it 'severities can be specified as array' do
+      formatter = -> { 'hello' }
+      logger.add_device(STDERR)
+      logger.set_formatter(formatter, ['debug', 'info'])
+      expect(logger.formatter_for('info')).to be(formatter)
+    end
+
+    it 'raise an error if severity is invalid' do
+      expect {
+        logger.set_formatter(:foo) { 'hello' }
+      }.to raise_error(ArgumentError, 'Invalid log severity: :foo')
+    end
+
+    it 'returns self' do
+      expect(logger.set_formatter(-> {}, :debug)).to be(logger)
+    end
+
+  end
+
   describe '#warn' do
 
     it 'does not output anything if there is no device' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiple_devices_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport