multiple_devices_logger 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6446bb60c3aa2bd4d77ede3192dbcea1e7ccf1b
-  data.tar.gz: fdaabdb5898c18815d5c63bd2ae5af243a0bf30e
+  metadata.gz: 8ae86567df1e4256c8ed249fb12684753e072f26
+  data.tar.gz: cf237ccec6259568639c300bcd70ecb883fca1f0
 SHA512:
-  metadata.gz: 9889055f04b023e94470a1b6ba0358a6247bcd909e6b9534914c958e357fb50316ab0dd7119ba139d62b1fe9bf0bbfebc372e624809cf2e03f01dcdcbefa4af5
-  data.tar.gz: a6ecb9eebccd038791def48cfd5b045ac970adbd4ae9be86aae332e73ca0e7dd2d1780ff867d2870c439e40372c026bc9244d89ec5398520b37ac734fbc2c83d
+  metadata.gz: 2ee12be1c9b809603600ef58a6615ee5973a64a1f43ec6b5e9c5092a000cfdd7fd112e2f9e57a1b0ea3e1545884fc29fce0f4c42d5e9ed6c5ffaeec112a77002
+  data.tar.gz: a2e849b612fe6430eb6826e6d106bc196810f3a7be700622a743a288970ec50fe7f32c79a7c7d5a0b721e350326d489507013036d3e2f24827d0b6bcf385fca5

data/README.mdown

@@ -68,26 +68,17 @@ Just use `#clear_devices` to clear all registered devices:
 logger.clear_devices
 ```
 
-### Custom formatter for each severity
+### Custom formatter for each device
 
-`MultipleDevicesLogger` allows you to configure a formatter for each
-severity via `#set_formatter` method, here is some examples:
+You can configure a formatter for each device via `:formatter` option, here
+is an example:
 
 ```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}" }
+logger.add_device(STDERR, :debug, formatter: -> (severity, time, progname, message) { "[#{severity}] #{message}\n" })
 ```
 
+Otherwise default formatter is used.
+
 ## Executing test suite
 
 This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).

data/VERSION

@@ -1 +1 @@
-1.1.0
+2.0.0

data/lib/multiple_devices_logger.rb

@@ -18,7 +18,6 @@ class MultipleDevicesLogger < Logger
   def initialize
     super(nil)
     clear_devices
-    clear_formatters
   end
 
   def add(severity, message = nil, progname = nil)
@@ -33,9 +32,9 @@ class MultipleDevicesLogger < Logger
         progname = self.progname
       end
     end
-    text = formatter_for(severity).call(format_severity(severity), Time.now, progname, message)
     devices_for(severity).each do |device|
-      device.write(text)
+      formatter = device.formatter || self.formatter || @default_formatter
+      device.write(formatter.call(format_severity(severity), Time.now, progname, message))
     end
     true
   end
@@ -44,7 +43,13 @@ class MultipleDevicesLogger < Logger
   def add_device(device, *severities)
     severities = [severities].flatten
     options = severities.extract_options!
-    device = LogDevice.new(device, options) unless device.is_a?(LogDevice)
+    formatter = nil
+    if options.key?(:formatter)
+      formatter = options.delete(:formatter)
+      raise ArgumentError.new("Formatter must respond to #call, #{formatter.inspect} given") unless formatter.respond_to?(:call)
+    end
+    device = LogDevice.new(device, options) unless device.is_a?(Logger::LogDevice)
+    device.formatter = formatter
     if severities.empty?
       keys = SEVERITIES.values
     else
@@ -61,10 +66,6 @@ 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
@@ -73,29 +74,10 @@ 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)
@@ -119,3 +101,9 @@ class MultipleDevicesLogger < Logger
   end
 
 end
+
+class Logger::LogDevice
+
+  attr_accessor :formatter
+
+end

data/spec/multiple_devices_logger_spec.rb

@@ -73,10 +73,10 @@ describe MultipleDevicesLogger do
       logger.add(Logger::WARN, nil, 'BAM!')
     end
 
-    it 'use formatter set via #set_formatter method' do
-      logger.set_formatter('> debug') { |severity, time, progname, message| "Hello #{message}" }
+    it 'use formatter set' do
+      logger.add_device(STDERR, '> debug', formatter: -> (severity, time, progname, message) { "Hello #{message}" })
       expect(STDERR).to receive(:write).with('Hello John')
-      logger.add(Logger::WARN, 'John')
+      logger.add(Logger::INFO, 'John')
     end
 
     it 'use default formatter if not set' do
@@ -86,14 +86,16 @@ describe MultipleDevicesLogger do
     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}" }
+      logger.add_device(STDERR, '<= info', formatter: -> (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')
+
+      expect(STDERR).to receive(:write).with('Hello John')
+      logger.add(Logger::INFO, 'John')
     end
 
   end
@@ -304,16 +306,29 @@ describe MultipleDevicesLogger do
     end
 
     it 'given options are forwared to LogDevice constructor' do
-      expect(Logger::LogDevice).to receive(:new).with(STDOUT, foo: 'bar')
+      device = Logger::LogDevice.new(STDOUT)
+      expect(Logger::LogDevice).to receive(:new).with(STDOUT, foo: 'bar').and_return(device)
       logger.add_device(STDOUT, Logger::INFO, foo: 'bar')
     end
 
+    it 'does not forward :formatter option to log device constructor' do
+      device = Logger::LogDevice.new(STDOUT)
+      expect(Logger::LogDevice).to receive(:new).with(STDOUT, foo: 'bar').and_return(device)
+      logger.add_device(STDOUT, Logger::INFO, foo: 'bar', formatter: -> {})
+    end
+
     it 'raise an error for default severity' do
       expect {
         logger.add_device(STDERR, 'default')
       }.to raise_error(ArgumentError, 'Invalid log severity: "default"')
     end
 
+    it 'raise an error if formatter is not a proc' do
+      expect {
+        logger.add_device(STDOUT, formatter: :foo)
+      }.to raise_error(ArgumentError, 'Formatter must respond to #call, :foo given')
+    end
+
   end
 
   describe '#clear_devices' do
@@ -327,19 +342,6 @@ 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
@@ -401,40 +403,6 @@ 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
@@ -483,73 +451,6 @@ 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multiple_devices_logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexis Toulotte